Django-Rest-API

A REST api written in Django for people who struggles with Calculus but loves coding. API's are open source and anyone can use it for non-commercial needs. You can find detailed documentation at: https://api-mathemagics.herokuapp.com/

Technologies used

• Django: (v 3.2.13) The web framework for perfectionists with deadlines (Django builds better web apps with less code).
• Django REST Framework: (v 3.13.1) A powerful and flexible toolkit for building Web APIs
• Other dependencies are found at ./backend/requirements.txt

Installation

• If you wish to run your own build, first ensure you have python globally installed in your computer. If not, you can get python here.

• After doing this, confirm that you have installed virtualenv globally as well. If not, run this:

      $ pip install virtualenv

• Then, Git clone this repo to your PC

      $ git clone https://github.com/mathemagic-art/Django-REST-API

• Dependencies

  1. Cd into your the cloned repo as such:

         $ cd django-rest-api

  2. Create and fire up your virtual environment:

         $ virtualenv  venv -p python3
         $ source venv/bin/activate

  3. Install the dependencies needed to run the app:

         $ pip install -r requirements.txt

  4. Make those migrations work

         $ python manage.py makemigrations
         $ python manage.py migrate

• Run It

  Fire up the server using this one simple command:

      $ python manage.py runserver

  You can now access the file api service on your browser by using

      http://localhost:8000/