Skip to content

WORKFLOW.md

Latest commit

 

History

History
46 lines (34 loc) · 1.61 KB

WORKFLOW.md

File metadata and controls

46 lines (34 loc) · 1.61 KB

Setup and running of project (Backend)

  • Fork the repo and clone it.
  • Go in the repo and setup virtualenvironment using
    python -m venv env
  • Then activate the environment using
    On Windows source env\Scripts\activate On MacOS/Linux source env/bin/actiavte
  • At the root of your project directory 
pip install -r engbook/requirements.txt

  • Rename .env.example to .env

  • Put the .env file in /engbook set secret key for your django project.

  • You can use [https://djecrety.ir/] to generate your secret key

  • Set DEBUG = True during development in .env file

  • After the above setup, run
    python engbook/manage.py makemigrations python engbook/manage.py migrate

  • Start the backend server (testing server) python engbook/manage.py runserver Runs the backend server at default port 8000.
    Open http://localhost:8000 to view it in the browser.

The page will reload if you make edits.

  • Start the production server (nginx) sudo docker-compose up --build Runs the backend server, bound to 0.0.0.0:80. This will NOT hot reload, and needs sudo permissions to run. Do not use this with debug=True in the .env file.

Open http://localhost to view it in the browser.

To spin down : sudo docker-compose down --remove-orphans

Note

  • If you are adding any new requirements for the project, make sure that you are adding it to requirements.txt in the engbook folder.
  • Use only npm install package_name to add new packages to the frontend part.