Welcome to Driveway. Driveway is a simple Node JS API that allows users (admin) to manage parking spaces.
-
Install Node.js
-
Install Yarn package manager
-
Clone the repo by running
git clone https://github.com/Ijebusoma/driveway.git
-
CD into the root of the project directory
-
Run
yarn install
or on the terminal to get all needed dependencies -
Run
yarn run test:server
to ensure the app is not broken -
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
-
Once the set up is complete, to start the application run
yarn run start:server
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.