Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/algo-phantoms/algo-phantoms-backend

💻 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.✨
https://github.com/algo-phantoms/algo-phantoms-backend

algorithms data-structures django django-application django-rest-framework python3

Last synced: about 1 month ago
JSON representation

💻 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.✨

Awesome Lists containing this project

README

        

# Algo-Phantom-Backend

backend final.png

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg)](https://www.python.org/) [![Open Source Love svg1](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) ![contributions welcome](https://img.shields.io/static/v1.svg?label=Contributions&message=Welcome&color=0059b3&style=flat-square) ![Maintenance](https://img.shields.io/maintenance/yes/2021)

![GitHub Repo stars](https://img.shields.io/github/stars/Algo-Phantoms/Algo-Phantoms-Backend?style=social)
![GitHub forks](https://img.shields.io/github/forks/Algo-Phantoms/Algo-Phantoms-Backend?style=social)

#### 💻 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

Python Django Django Rest Framework

## 💫 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
```

- Create virtual environment- For Windows

```
python -m venv env
env\Scripts\activate
```

- Create virtual environment- For Linux

```
python3 -m venv env
```

      or

```
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 ""
git push --set-upstream origin
```

## 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](https://github.com/Algo-Phantoms/Algo-Phantoms-Backend/blob/main/README.md).**

## 📖 Code Of Conduct:

You can find our Code of Conduct [here](https://github.com/Algo-Phantoms/Algo-Phantoms-Backend/blob/main/CODE_OF_CONDUCT.md).

## 📝 License

This project follows the [MIT License](https://choosealicense.com/licenses/mit/).

## 😇 Maintainers



Diya Jaiswal

💻



Prajul Gupta

💻


Hetal Mangukia

💻



Harsh Kumar

💻


## If you liked the project don't forget to star 🌟 and fork 🍽 the project.

Made with ❤ by Algo Phantoms

[![forthebadge](https://forthebadge.com/images/badges/built-by-developers.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/uses-git.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/built-with-love.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/made-with-python.svg)](https://forthebadge.com)
[![forthebadge](https://forthebadge.com/images/badges/open-source.svg)](https://forthebadge.com)