Giter VIP home page Giter VIP logo

euginelethal / order-api Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 7.59 MB

Order-Api is a simple REST API used to upload customers orders built with Django Rest Framework..This project was for leveling up on Test-driven development and CI/CD https://backend-challenge5.herokuapp.com/oidc/authenticate/

Home Page: https://backend-challenge5.herokuapp.com/

Python 4.87% Dockerfile 0.11% CSS 37.43% JavaScript 56.75% HTML 0.83% Procfile 0.02%
order-management api-rest tdd-python pytest travis-ci africastalking ci-cd deployment-heroku smsgateway testcoverage

order-api's Introduction

Build Status Coverage Status

ORDER-API

..Order-Api is a simple REST API used to upload customers orders.

..User Stories

Users authenticates via OAUTH2 and OpenidCOnnect(GOogleOAuth 2.0 )
Customer creates order
Customers gets message after order created sucessfully(Asynchronous Task)

Tools and Technologies

  1. Django
  2. DjangoRest
  3. Travis(CI/CD)
  4. Heroku-Deployment
  5. AfricaisTalking-(SMSGATEWAY)
  6. Coverage
  7. Celery
  8. Redis
  9. Pytest
  10. Docker
  11. Docker-Compose

API ENDPOINTS

Run in Postman

Question Endpoints.

API Endpoint Description Methods
/oidc/authenticate/ Authentication GET
/api/v1/customer create customer POST
/api/v1/order Get all orders GET
/api/v1/order Customer posts order POST

Getting Started

To get started: Git clone the repository using https://github.com/EUGINELETHAL/Backend-challenge For the API to run smoothly you will need the following:

1. Python 3.6 or higher installed.
2. Pip3
3. Pipenv or virtualenv installed.

Installing

Local Development Guide.

  1. Git clone the repository using
  2. Through your terminal, navigate to the location with the cloned repository.
  3. Open the cloned repo folder using your terminal.
  4. You're currently on the main branch.

Running the tests

pytest

Style Guide.

PEP 8

Deployment

Heroku

Built With

  • Django and Django Rest Framework

Authors

  • Ochung Eugine.

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.