This repository has been archived by the owner on Mar 30, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
43 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# Cultidate Backend | ||
|
||
## Initial Setup | ||
|
||
Django REST Framework and various libraries defined in `requirements.txt` are utilized. Agents should have Python 3, pip and virtualenv initially. | ||
|
||
- Create a virtual environment: | ||
|
||
`virtualenv env` | ||
|
||
- Activate the virtual environment: | ||
|
||
`source env/bin/activate` or | ||
|
||
`source env/Scripts/activate` for Windows | ||
|
||
- Install dependencies from `requirements.txt` | ||
|
||
`pip install -r requirements.txt` | ||
|
||
- There should also be a `.env` file which some of Django parameters and API keys are kept. This file can be created manually with deployment specific variabled or gathered from the backend team. | ||
|
||
## Running the Project | ||
|
||
Check if Django configured correctly: | ||
|
||
`./manage.py check` | ||
|
||
Run local development server: | ||
|
||
`./manage.py runserver 8000` | ||
|
||
Make migration files: | ||
|
||
`./manage.py makemigrations` | ||
|
||
Migrate models to defined db: | ||
|
||
`./manage.py migrate` | ||
|
||
Use Django Shell: | ||
|
||
`./manage.py shell` |