max

Technologies Used

• NodeJS
• ExpressJS
• [Postgresql]
• [docker]

Documentation

• Api documentation is currently hosted at https://star-wars-abiola.herokuapp.com/api-docs/

Getting Started

---

Installing/Run locally

• Make sure you have nodejs, postgres installed.

    - npm install
  
    - Create/configure `.env` environment with the following credentials
      DATABASE_URL
    - Run `npm run create` to create database table
    - Run `npm start` to start the server

Run with docker

• Make sure you have docker installed.

    - cd to the folder directory and Run `docker-compose up`

Testing

• To test or consume the API locally, you can make use of Postman to simulate a front-end client.
• You can also test by running npm test.

HTTP Requests

All API requests are made by sending a secure HTTPS request using one of the following methods, depending on the action being taken:

• POST Create a data
• GET Get a data or data

HTTP Response Codes

Each response will be returned with one of the following HTTP status codes:

• 200 OK The request was successful
• 201 OK created successfully
• 400 Bad Request There was a problem with the request (security, malformed)
• 500 Internal serval error There was a problem with the network or database