Algo-Phantom-Backend

contributions welcome Maintenance

💻 Algo-Phantoms-Backend is an Application that provides pathways and quizzes along with a code editor to help you towards your DSA journey.📰🔥 This repository contains the REST APIs of the application.✨

🔥 Features

📰 Write and edit your code in our application.

✨ Play quizzes to improve your DSA fundamentals.

🚀 Give your DSA journey a proper guide using pathways in our application.

🛠 Tech Used

💫 Quick Start

Fork and Clone the repository using-

git clone https://github.com/Algo-Phantoms/Algo-Phantoms-Backend.git

Create a Branch-

git checkout -b <branch_name>

Create virtual environment- For Windows

python -m venv env
env\Scripts\activate

Create virtual environment- For Linux

python3 -m venv env

virtualenv env

Start virtual environment- For Linux

source env/bin/activate

Install dependencies using-

pip install -r requirements.txt

If you have python2 and python3 installed you need to specify python3 by using command:

python3 -m pip install -r requirements.txt

Headover to Project Directory-

cd AlgoPhantomBackend

Make migrations using-

python manage.py makemigrations

If you have python2 and python3 installed you need to specify python3 by using command:

python3 manage.py makemigrations

Migrate Database-

python manage.py migrate

Create a superuser-

python manage.py createsuperuser

Run server using-

python manage.py runserver

Push Changes-

git add .
git commit -m "<your commit message>"
git push --set-upstream origin <branch_name>

Project Architecture

ALGO-PHANTOMS-BACKEND                             # Project Name
|
├───AlgoPhantomBackend                            # Project Directory
|   |
|   └──__pychache__                               # Cache Folder            [Default]
|   ├──__init__.py                                #                         [Default]
|   ├──asgi.py                                    #                         [Default]
|   ├──settings.py                                #                         [Default]
|   ├──urls.py                                    #                         [Default]
|   └──wsgi.py                                    #                         [Default]
|
├───core                                          # Core App Directory
|   |
|   └──migrations                                 # Migrations
|   ├──_init__.py
|   ├──admin.py                                   #                         [Default]
|   ├──apps.py                                    # Define App name         [Default]
|   ├──models.py                                  # Create models           [Default]
|   ├──serializers.py                                                       [Created]
|   ├──signals.py                                                           [Created]
|   ├──tests.py                                   # Test                    [Default]
|   ├──tokens.py                                  #                         [Created]
|   ├──urls.py                                    #                         [Created]
|   ├──utils.py                                   #                         [Created]
|   └──views.py                                   #                         [Default]
|
├───quiz                                          # Quiz App Directory
|   |
|   └──migrations                                 #                         [Default]
|   ├──_init__.py                                 #                         [Default]
|   ├──admin.py                                   #                         [Default]
|   ├──apps.py                                    #                         [Default]
|   ├──models.py                                  #                         [Default]
|   ├──serializers.py                             #                         [Created]
|   ├──tests.py                                   #                         [Default]
|   ├──urls.py                                    #                         [Created]
|   └──views.py                                   #                         [Default]
|
├──manage.py                                      #                         [Default]
└──requirements.txt                               #                         [Created]

⚙️ Contribution Guidelines

Make sure you do not copy codes from external sources because that work will not be considered. Plagiarism is strictly not allowed.
You can only work on issues that you have been assigned to you.
If you want to contribute, we prefer that you create an issue before making a PR and link your PR to that issue.
If you have modified/added code work, make sure the code compiles before submitting.
Do not update the README.md.