Getting Started
If you are trying to use this project for the first time, you can get up and running by following these steps.
To contribute to this project, please see the contributing guidelines.
⚠ Note, this step assumes you are using github ssh keys for the git clone method
The Mumble Diagram
--> Preview :
--> Full View:
You can see clearly the diagram at :
Requirements
Technology | Version |
---|---|
Python | 3.x |
pip | latest version |
asgiref | 3.3.4 |
dj-database-url | 0.5.0 |
Django | 3.2 |
django-cors-headers | 3.7.0 |
django-heroku | 0.3.1 |
djangorestframework | 3.12.4 |
djangorestframework-simplejwt | 4.6.0 |
gunicorn | 20.1.0 |
Pillow | 8.2.0 |
psycopg2 | 2.8.6 |
PyJWT | 2.0.1 |
pytz | 2021.1 |
six | 1.15.0 |
sqlparse | 0.4.1 |
whitenoise | 5.2.0 |
Install and Run
Make sure you have Python 3.x installed and the latest version of pip installed before running these steps.
To contribute, please follow the guidelines process.
Clone the repository using the following command
git clone [email protected]:divanov11/mumbleapi.git
# After cloning, move into the directory having the project files using the change directory command
cd mumbleapi
Create a virtual environment where all the required python packages will be installed
# Use this on Windows
python -m venv env
# Use this on Linux and Mac
python -m venv env
Activate the virtual environment
# Windows
.\env\Scripts\activate
# Linux and Mac
source env/bin/activate
Install all the project Requirements
pip install -r requirements.txt
-Apply migrations and create your superuser (follow the prompts)
# apply migrations and create your database
python manage.py migrate
# Create a user with manage.py
python manage.py createsuperuser
Load test data to your databsae
# load data for feed
python manage.py loaddata feeddata.json
# load data for article
python manage.py loaddata articledata.json
# load data for discussion
python manage.py loaddata discussiondata.json
Run the development server
# run django development server
python manage.py runserver
Reviewers
After submitting your PR, please tag reviewer(s) in your PR message. You can tag anyone below for the following.
-
Markdown, Documentation, Email templates:
-
API, Backend, Databases, Dependencies:
--> Choose two reviewers :
Explore admin panel for model data or instances
http://127.0.0.1:8000/admin or http://localhost:8000/admin
Login with the user credentials (you created) using "createsuperuser" cmd
⚠ If everything is good and has been done successfully, your Django Rest API should be hosted on port 8000 i.e http://127.0.0.1:8000/ or http://localhost:8000/