#Locale--Nigeria-Geographical-Data-API
### Table of contents
- About The Project
- Built With
- Getting Started
- usuage
- contributing
- License
- Contact
## About The Project
Locale is a developer tool for anyone who needs to knows Nigeria. This API shows all of Nigeria's regions, states, local government Areas.
## Built With
- NodeJS - Javascript runtime environment
- MongoDB - A NoSQL database
- ExpressJS - A web framework for NodeJS
- Redis - In-memory data structure store
- Mongoose - MongoDB object modelling for NodeJS
- JWT - Tool for genertaing and verifying token
- Swagger - Simplify API development, documentation and visualization
## Getting Started
To get a local of the code up and running, follow the steps below.
### Pre-requisites
Make sure you have NodeJS and Redis installed.
### Installation
1. Clone the repo:
```sh
git clone
github.com
2. Enter the project directory
```sh
cd nigeria-locale
3. Install packages
```sh
npm install
4. Configure the environment variable. Fill in the environment variables.
```sh
cp .example.env .env
5. Run the development server:
```sh
npm run dev
### Usage
For the online documentation - Visit
locale-nigeria-geographical…