devppratik / EnigmaCMS-Backend

Server for our Club

EnigmaCMS-Backend

Server for our Club

Getting Involved

We encourage you to participate in this open source project. We love Pull Requests, Bug Reports, ideas, (security) code reviews or any other kind of positive contribution.

Before you attempt to make a contribution please read the Community Participation Guidelines.

• Guide to Contributing code (New contributors read the community guidelines and start here!)

• View current Issues

• View current Pull Requests

• or file a issue

• Haven't joined our discord server? join here to keep up to date.

Beginners! - Watch out for Issues with the "Good First Issue" label. These are easy bugs that have been left for first timers to have a go, get involved and make a positive contribution to the project!

Languages / Framewoks involved

• Languages
  • Python
• Frameworks
  • django
  • Graphene
• Database
  • MongoDB

Build Instructions

1. Clone or Download the repository:

git clone https://github.com/EnigmaVSSUT/EnigmaCMS-Backend

2. Inside the Enigma_CMS_backend/project start the server by entering into the terminal $ python manage.py runserver

Setting up the environment (Linux and MacOS)

Always make sure you have python 3 and are using virtualenv to install and manage your packages First get into Enigma_CMS_backend/project an then follow the steps given below

1. pip3 install virtualenv -> Install the virtualenv library
2. virtualenv .venv -> Create a virtual environment
3. source .venv/bin/activate -> Get inside the virtual environment
4. pip install --upgrade pip -> get upgraded to pip3
5. pip install -r requirements.txt -> Thereafter install all the packages as per the reqirements.txt

Opening django shell to visualize the data (Linux and MacOS)

1. python manage.py shell_plus --notebook -> Install the django_extensions, IPython and notebook libraries

Setting up the environment (Windows)

Always make sure you have python 3 and are using virtualenv to install and manage your packages First get into Enigma_CMS_backend/project an then follow the steps given below

1. py -m pip install --user virtualenv -> Install the virtualenv library
2. py -m venv env -> Create a virtual environment
3. .\env\Scripts\activate -> Get inside the virtual environment
4. pip install --upgrade pip -> get upgraded to pip3
5. pip install -r requirements.txt -> Thereafter install all the packages as per the reqirements.txt

API endpoints

Endpoints (Enigma)

• Api.enigmavssut.com/courses/article-list methods= POST, GET
• Api.enigmavssut.com/courses/track-list methods= POST, GET
• Api.enigmavssut.com/courses/article-list methods=GET
• Api.enigmavssut.com/courses/topic-detail// methods=GET, DELETE
• Api.enigmavssut.com/courses/article-detail// methods=GET, DELETE
• Api.enigmavssut.com/courses/track-detail// methods=GET, DELETE
• Api.enigmavssut.com/courses/create-article methods=POST
• Api.enigmavssut.com/courses/edit-article// methods=PUT
• Api.enigmavssut.com/courses/edit-track// methods=PUT
• Api.enigmavssut.com/courses/edit-topic// methods=PUT
• Api.enigmavssut.com/courses/article-status-update/ methods=POST
• Api.enigmavssut.com/courses/article-details-list methods=GET
• Api.enigmavssut.com/courses/article-image-list/ methods=GET
• Api.enigmavssut.com/courses/article-image-detail// methods=GET