This README provides a quick overview of how to clone the CareFlow repository, build it into an executable JAR, and deploy it to different environments (e.g., test and production).
git clone https://github.com/ReniIrinyi/CareFlow.git
cd CareFlow
-
Create a JAR Artifact
- In your IDE, go to File → Project Structure → Artifacts.
- Create a JAR artifact (e.g.,
<ArtifactName>
). - Specify the path to the main class (e.g.,
Main.kt
).
-
Include Resources
- Place your CSS files,
.txt
files, and any other resources into theresources
folder so they will be automatically included in the JAR.
- Place your CSS files,
-
Build the JAR
- In your IDE, select Build → Build Artifacts → → Build.
- The generated JAR will typically appear in:
out/artifacts/<ArtifactName>
- This JAR contains all classes and resources required to run the application.
-
Test Environment
- Run the generated JAR locally or on a test server:
java -jar <ArtifactName>.jar
- Confirm that configuration files (e.g.,
application.properties
) and environment variables are correct.
- Run the generated JAR locally or on a test server:
-
Production Environment
- Copy or upload the JAR file to your production server.
- Adjust all production-specific settings (database URL, credentials, ports, etc.).
- Launch the JAR:
java -jar <ArtifactName>.jar
-
Monitoring & Maintenance
- Watch the application logs for errors or warnings.
- Restart or update the service as needed.
Note:
Adjust repository URL, file paths, and artifact names as appropriate for your specific environment.
If you need more details, refer to the project’s documentation or contact me ⛹️♀️