Taxi24-API

Taxi24 is a new startup based in Kigali. They would like to disrupt the taxi industry in Rwanda by providing a white-label solution to the existing taxi companies and hotels.

Staging environment base URL

https://taxi24-app.herokuapp.com/api/v1/

Setting Up The Application in development environment

I. Clone the Application

Open your terminal
Run clone https://github.com/victkarangwa/Taxi24-API.git OR Download the project

II. Setting up the environment

Create a .env file reflecting to .env.example file
Add the values to all environmental variables in .env file
Make sure you have PostgreSQL installed (You can download it here)
This app uses Google direction api. Thus, you need to also provide google API keys. Read more on Directions API

III. Testing the application

Run npm run test or yarn test
You should get 13 passing test

IV. Running the application

Open termin in the directory you clone the repo from:

Run npm install to install all dependencies
Using postgres, create database for both dev and testing environment. In your .env, database URL should be of this format: DATABASE_DEV_URL=postgres://[user]:[password@[host]:[port/[db_name] ex: DATABASE_DEV_URL=postgres://postgres:123@localhost:5432/taxi24_dev
Run npm run db:migrate or yarn db:migrate to automatically create all necessary models
Run npm run db:seed:dev or yarn db:seed:dev to seed data in the database
Run npm run dev-server to start local development server. You can also simulate production server locally by running npm start
Open your postman and access http://localhost:<:APPLICATION_PORT> (by default, the port is 3000) , if app is running correctly, you will get a response with a message:
```
{
   status: 200,
   message: "TAXI24 APIs"
}
```
For more, please read Taxi24 API documentation

Author 💻

Victor KARANGWA

About