Git Product home page Git Product logo

awwwards-like-api's Introduction

Project

REST API created with django-rest-framework, This api lets users to create projects and add images for them to be rated/reviewed.

Tech stack

  • Django 4.0.4

  • Django-rest-framework

  • simple jwt(authentication)

  • CORS headers (for api cunsumption)

  • Front-end

    • AngularJs 13
    • Bootstrap

Installation

  1. Clone repo
  2. cd into sturdy-doodle
  3. create virtual environment: (virtualenv, pipenv, conda, e.t.c)
  4. install all project dependencies; pipenv install Pipfile
  5. Run with python manage.py runserver

setup

  • create dot-env file .env add the following inside the environment file
DB_USER = <username >
DB_PASSWORD = <password >
DB_HOST = <host >
DB_PORT = <port >
DB_NAME = <dbname >
SECRET_KEY = <secret_key >
MODE = 'dev'

CLOUDINARY_CLOUD_NAME = <cloud_name >
CLOUDINARY_API_KEY = <api_key >
CLOUDINARY_API_SECRET = <api_secret >

Running

This API can be consumed using a language of your choice.

Nb: use postman to test.

  • for authentication pass in the jwt access token in http headers: 'Authorization Bearer: <acces_token>' Below are availabe endpoints:
  1. Register: <link>/register/
  2. Login :: <link>/login/
  3. Root View :: <link>/api/
  4. Projects view :: <link>/api/projects/
  5. View single project :: <link>/api/projects/
  6. Rate view :: <link>/api/projects/1/rate_project/

Same endpoits applies to a local running app on localhost:

Deployed version

API link

awwwards-like-api's People

Contributors

willbeckh avatar

Watchers

 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.