wrillrysata/driveway

Car Park Manager API

Driveway

A simple Node JS API that allows users (admin) to manage parking spaces.

Core Technologies

• Nodejs
• Express
• Postgres
• Sequelize ORM
• Mocha
• Chai

To get started

1. Install Node.js

2. Install Yarn package manager

3. Clone the repo by running git clone https://github.com/Ijebusoma/driveway.git

4. CD into the root of the project directory

5. Run yarn install or on the terminal to get all needed dependencies

6. Run yarn run test:server to ensure the app is not broken

7. Create a .env file in the root directory of the app. An example of the content in the .env file can be found here .env.example

8. Once the set up is complete, to start the application run yarn run start:server

Endpoints

Access to endpoints are restricted based on the authorization token assigned to the user. The token is automatically generated when a new user signs up and when a returning user signs in.