Information and instructions on setting up a development environment can be found in the wiki
For information on Netlify deployment see the Wiki @ Netlify
For Heroku deployment see the Wiki @ Heroku
- JavaScript
- NodeJS
- Netlify - A free website hosting service
- ReactJS - A client-side JavaScript library for building interfaces
- Axios - Promise based HTTP client for the browser and node.js
- React-Router - A package providing dynamic routing functionality for web apps
- React-Router-Dom - A package containing the DOM bindings for react-router
- Python
- Heroku - to host a deployed version of the API remote
- PostgreSQL - An open source SQL database
- Django - A high level Python Web Framework
- Django Rest Framework - A Django extension for building APIs
In order to authenticate, you need to create an account or log in with an email and password on the route users/create
Once created, you will recieve a token as a response
Add that token to your request headers in this format:
Key | Value |
---|---|
Authorization | token your token here |
And you will have full access to the API!
The following routes are available
Route name | URL | HTTP Verb | Description |
---|---|---|---|
Index* | /{resource} | GET | Display a list of all Project or Comment |
Show ID* | /{resource}/{:id} | GET | Display a specific Project or Comment based on their ID |
Create* | /{resource}/create | POST | Add new Project or Comment to the database, returns the newly created entry |
Edit By Id* | /{resource}/{:id} | PATCH | Update a particular Game or Review, returns the new entry |
Delete By Id* | /{resource}/{:id} | DELETE | Delete a particular Game or Review |
Login | /users/login | POST | Logs in with a username and password, returns an authentication token |
Create | /users/create | POST | Creates a user and returns an authentication token |
Routes marked with *
need authentication to be accessed