Website • Docs • Example

• About
• Getting Started
• Usage
• Set up the backend
• Set up backend
• Community
• Top-level directory layout
• Contributing

Nigeria API is an open-source project which was initiated at Automation Cube(wuralab)

The Projects aims at solving the problem of difficulties to find API that exposes DATA about Nigeria. Sometime we have project to work on where we need to display DATA about nigeria, such as University in nigeria, industry in nigeria.

The end goal of this project is to have enough DATA on nigeria which can be accessed through an API.

We want to take away the stress faced by developers when working on projects that involves or needs nigeria data.

1. Set up the backend

To make use of the API, There are two ways to set it up 2. Setting it up locally 3. Setting it using docker-compose

Let's start by setting up a database with some sample data. We'll use PostgreSQL and our example e-commerce dataset for this tutorial. You can download and import it by running the following commands.

$ curl <https://github.com/WuraLab/NigeriaApi/blob/sqlDump/output.sql> > outpput.sql
$ createdb <DBNAME>
$ psql --dbname <DBNAME> -f output.sql

For example,

$ curl <https://github.com/WuraLab/NigeriaApi/blob/sqlDump/output.sql> > outpput.sql
$ createdb nigeriaapidb
$ psql --dbname nigeriaapidb -f output.sql

The project uses environment variables for configuration, which starts with DEV_DATABASE_. To configure the connection to our database, we need to specify the DB name, user, password, and host. In the root project folder create a file called .env and fill it with the content in the .env.example file:

This method is suitable for anyone who wish to run the project locally without docker.

To run this application locally on your PC, you should have the following installed

1. Node js

2. PostgreSql

git clone https://github.com/<username>/NigeriaApi.git

Using npm

npm install

Using node

npm start

or nodemon(make sure you have nodemon installed on your local sysytem, perhaps installed globally using)

npm install -g nodemon

then you run the app with

npm run dev

By default, the applictaion is running on PORT 3000, this port can be changed in api/bin/www file on line 8.

To test the application, open you browser and type this in the address bar localhost:3000

The application can be run using docker also, you should the following installed

1. docker
2. docker compose

run docker-compose build . to build the docker file. run docker-compose up -d to run the application

Application runs on port 3000

https://nigeria-api.netlify.app/

JavaScript

If you have any questions or need help send a DM on to any of the amazing developers.

• Fawas
• Isreal
• Suen
• Adefemi

📦NigeriaAPI
    ┗ 📦.github
        ┗ 📦workflows
            ┣ 📜ci.yml
    📦.vscode
        ┣ 📜settings.json
    📦api
        ┗ 📦bin
            ┣ 📜www
        ┗ 📦config
            ┣ 📜config.js
        ┗ 📦controllers
            ┗ 📦email
                ┗ 📦templates
                    ┣ 📜signup.html
                ┣ 📜helper.js
            ┣ 📜user.js
        ┗ 📦helpers
            ┣ 📜authHelper.js
            ┣ 📜mailer.js
            ┣ 📜validationSchema.js
        ┗ 📦middlewares
            ┣ 📜validationMid.js
        ┗ 📦migrations
            ┣ 📜20200711012227-create-users.js
        ┗ 📦models
            ┣ 📜index.js
            ┣ 📜users.js
        ┗ 📦routes
            ┣ 📜index.js
        ┗ 📦test
            ┣ 📜test.js
    ┣ 📜app.js
    ┣ 📜.env.example
    ┣ 📜.eslintrc.js
    ┣ 📜.gitignore
    ┣ 📜.sequelizerc
    ┣ 📜package.json
    ┣ 📜package-lock.json
    ┣ 📜README.md

There are many ways you can contribute and help this project. Here a few ones:

• Star this repo.
• Upvote issues with 👍 reaction so we know what's the demand for particular issue to prioritize it within road map.
• Create issues every time you feel something is missing or goes wrong.
• Provide pull requests for all open issues and especially for those with help wanted and good first issue labels as those are out of Cube.js Core Team roadmap scope.