Skip to content

Latest commit

 

History

History
135 lines (121 loc) · 3.28 KB

README.md

File metadata and controls

135 lines (121 loc) · 3.28 KB
Raw

ProjetCoddityServerSide

About

  • Android app Api developed with Django Rest Framework
  • UTBM school Project

Api usage

/* Create new user */
POST "https://projetcoddityserverside.herokuapp.com/auth/register/" HTTP/1.1
content-type: application/json

{
    "username":"sosacy",
    "password":"calottedetesmorts"
}
/* Expected response */
HTTP/1.1 200 OK

/* Get authentification token */
POST "https://projetcoddityserverside.herokuapp.com/auth/token/" HTTP/1.1
content-type: application/json

{
    "username":"cyrille1",
    "password":"calottedetesmorts"
}
/* Expected response */
HTTP/1.1 200 OK
{
  "token": "8850f382acf9d6ea761024e9cf8e9b51a3d5e884"
}

/* List user using authentification token */
GET "https://projetcoddityserverside.herokuapp.com/auth/list" HTTP/1.1
Authorization: Token 8850f382acf9d6ea761024e9cf8e9b51a3d5e884
/* Expected response */
[
  {
    "username": "cyrille1"
  },
  {
    "username": "zebi"
  }
]

/* Add garbage using authentification token */
POST "https://projetcoddityserverside.herokuapp.com/grabthetrash/add-garbage/" HTTP/1.1
Authorization: Token 8850f382acf9d6ea761024e9cf8e9b51a3d5e884

owner:2
latitude:564
longitude:45656
image:image.jpg
/* Expected response */
{
    "owner": 2,
    "isRatingDone": false,
    "latitude": 564,
    "longitude": 45656,
    "image": "/media/garbage/Capture_d%C3%A9cran_127.png",
    "judge1": null,
    "ratingJudge1": null,
    "judge2": null,
    "ratingJudge2": null,
    "judge3": null,
    "ratingJudge3": null
}

/* List garbage using authentification token */
GET "https://projetcoddityserverside.herokuapp.com/grabthetrash/list-bin" HTTP/1.1
Authorization: Token 8850f382acf9d6ea761024e9cf8e9b51a3d5e884
/* Expected response */
[
    {
        "owner": 2,
        "isVerified": false,
        "isAccepted": false,
        "latitude": 564,
        "longitude": 45656,
        "image": "http://localhost:8000/media/defaults.jpg"
    },
    {
        "owner": 2,
        "isVerified": false,
        "isAccepted": false,
        "latitude": 564,
        "longitude": 45656,
        "image": "http://localhost:8000/media/defaults.jpg"
    }
]

/* Get garbages (3 maximum) to validate using authentification token */
GET "https://projetcoddityserverside.herokuapp.com/grabthetrash/garbages-to-validate" HTTP/1.1
Authorization: Token 8850f382acf9d6ea761024e9cf8e9b51a3d5e884
/* Expected response */
// Same as before

/* Post user answers about item to validate using authentification token */
POST "https://projetcoddityserverside.herokuapp.com/grabthetrash/garbages-validation" HTTP/1.1
Authorization: Token 8850f382acf9d6ea761024e9cf8e9b51a3d5e884
pk1:1
answer1:True
pk2:2
answer2:False
pk3:0 // When no answers
answer3:False
/* Expected response */
status code = 200

Dev env installation

# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
source env/bin/activate  # Linux
env\Scripts\activate # Win

# Install dependencies
pip install -r requirements.txt

# Generate staticfiles and databases
python manage.py makemigrations --noinput
python manage.py collectstatic --noinput
python manage.py migrate --noinput

# Launch debug application
python manage.py runserver

Heroku Deploy

  • Create heroku app and follow instructions
  • # Deploy modifications
git commit 
git push heroku main