shouryade / lmtsm-backend Goto Github PK

1. Clone the repo

   git clone https://github.com/shouryade/LMTSM-Backend.git
   cd LMTSM-Backend

2. Make your you have Python 3.10 installed on your system. If not, you can download it from here.

3. Install pipenv by running the following command in your terminal:

   pip install pipenv

4. Install the dependencies

    pipenv install

5. Activate the virtual environment

   pipenv shell

6. Run the server

   pipenv run python -m app

7. The server should be up and running on http://localhost:8100

1. Rename the .env.sample file to .env
2. Replace the values of the variables with your own values
3. Close the server by pressing Ctrl + C in the terminal.
4. Restart the server by running the following command:

   pipenv run python -m app

You can access the documentation of the backend by visiting http://localhost:8100/docs You can also try out the API endpoints by first authenticating and creating a user and setting their role to super_admin (using MongoDB Compass) and then using the Try it out button to make requests to the API.

Make sure you have docker and docker-compose and you are added in the docker user group. Run the following command to start the containers and setup volumes.

docker-compose -f docker-compose-prod.yml up -d

Execute docker ps to know the uptime and other details regarding the containers.