StudyCRM by Code Differently

Build instructions

Easy way (using VS Code)

1. Install VS Code and Docker. You can references the instructions here, if needed.
2. Click the Dev Containers button above to automatically clone and open the project in a new dev container.
3. Once the dev image is done loading projects, open a new VS Code terminal, run gradle start and use the Docker view in VS Code to see all the running containers. When done, you can shut everything down using gradle teardown.
4. To run all tests, use gradle test.
5. Configure your HOSTS file to add entries for local.studycrm.com and api-local.studycrm.com pointing to 127.0.0.1.
6. Profit!

Less easy way (using VS Code)

1. Install VS Code and Docker. You can references the instructions here, if needed.
2. Clone this repo to your local machine

mkdir source
git clone https://github.com/code-differently/study-crm 

1. Open the new folder you just downloaded in VS Code
2. Follow the prompts to automatically repoen the folder as a dev container.
3. Once the dev image is done loading projects, open a new VS Code terminal, run gradle start and use the Docker view in VS Code to see all the running containers. When done, you can shut everything down using gradle teardown.
4. To run all tests, use gradle test.
5. Configure your HOSTS file to add entries for local.studycrm.com and api-local.studycrm.com pointing to 127.0.0.1.
6. Profit!

Least easiest way (suitable if using another coding editor)

1. Install VS Code and Docker. You can references the instructions here, if needed.
2. Install Java 17 and Gradle.
3. Clone this repo to your local machine

mkdir source
git clone https://github.com/code-differently/study-crm 
cd study-crm 

1. You can now open the project in your favorite coding editor.
2. To start all the services, run gradle start in the study-crm directory. You should see all the containers running in Docker. When done, you can shut everything down using gradle teardown.
3. To run all tests, use gradle test.
4. Configure your HOSTS file to add entries for local.studycrm.com and api-local.studycrm.com pointing to 127.0.0.1.
5. Profit!