Giter Club home page Giter Club logo

master_devel_testing_api's Introduction

CUSTOM REST API

This project implements a custom api with a custom authentication method.

Get Ready

Basic programs you need for the commands to work

  • Any shape or form to download this repository into you desired folder
git clone https://github.com/SamiUrias/master_devel_testing_api.git
  • Pipenv: I use pipenv to create and manage my virtualenv, then I am going to explain how to make this project run using pipenv.
  • Postgresql (DBMS): I choose postgres for this project, despite the fact that django can handle multiple databases I strongly suggest to use postgres to smoothly follow this readme.
  • Optional: I am in Ubuntu 18.04 ( for reference )

Setup

  • Install all the dependencies in your virtual environment.
pipenv install
  • Create a new postgres database
  • Modify the /api/settings.py in the database section with your database configuration
  • Run the following command to activate the shell of pipenv
pipenv shell
  • Apply all the migrations
python manage.py migrate
  • Run the development server
python manage.py runserver

Versions

General

Dendencies that will be installed once the project is started

Package Version
asgiref 3.2.7
Django 3.0.7
djangorestframework 3.11.0
importlib-metadata 1.6.1
Markdown 3.2.2
psycopg2 2.8.5
pytz 2020.1
sqlparse 0.3.1
zipp 3.1.0

Alternative Install

General

I left a requirements.txt file in the project if you want to use a conventional installation using vevnv.

  • Create a new virtual environment
virtualenv venv
  • Activate the environment
source /venv/bin/activate
  • Install all the dependencies
pip install -r requirements.txt

To Install psycopg2 you are going to need the python development packages

sudo apt-get install libpq-dev python-dev
  • Create a new postgres database

  • Modify the /api/settings.py in the database section with your database configuration

  • Apply all the migrations

python manage.py migrate
  • Run the development server
python manage.py runserver

master_devel_testing_api's People

Contributors

samiurias avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.