If you don’t want to install local dependencies on your machine, please navigate to the Start with Docker to get started.

​
Setup your development

Prerequisite You should have installed the following dependencies:

​
Step 1. Clone Igbo API repo

git clone https://github.com/nkowaokwu/igbo_api.git

​
Step 2. Install dev dependencies

cd igbo_api/
npm install

​
Step 3: Build the project

npm run build

​
Step 4: Run the project

npm run dev

The Igbo API will be running at http://localhost:8080

The Igbo API website will be running at http://localhost:3000

​
Enable Firebase Authentication

This project uses Firebase and requires you to create your own free Firebase project.

Please follow the Firebase Configuration Guide here

​
Optional: Development with Replica Sets and Redis

Running replica sets locally is machine-intensive and should only be ran for testing or specific-feature development purposes.

To start the dev API server while running MongoDB Replica sets and the Redis cache, run:

npm run dev:full:database

To start a Redis server, run:

redis-server

You must have Redis installed on your machine in order to run the server.