Table of Contents
As always, All My projects are simple and unique. This one is no exception. I have been wanting to build this project for awhile now, especially when I was learning how to use react.js. I remember searching for an election API then and couldn't get one at the time. I picked Nigeria as country simply because, it is my country and the data is easy to use but its not so easy to get the complete election data. Only Admin an alter or delete the election data.
Benefits of this API:
- The API is free, thereby granting unlimited access to Nigerian election data
- Easy integration to any application
- Easily accessible to the public through RapidAPI Hub.
For now, Only admin can login or register a user, the user endpoints isn't accessible to the general public for security reasons.
Here are the list of major frameworks/ libraries used to bootstrap this project
To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
-
npm
npm install npm@latest -g
Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.
-
Clone the repo
git clone https://github.com/BigYusuf/election.git
-
Install NPM packages
npm install
-
Enter your KEYS in
.envNODE_ENV = "CHOOSE WHETHER ITS DEVELOPMENT OR PRODUCTION MODE"; PORT = "ENTER YOUR DESIRED PORT NUMBER"; MONGO_URL = "ENTER YOUR MPNGODB URL"; JWT_SECRET = "ENTER YOUR JWT SECRET"; JWT_SECRET = "ENTER YOUR JWT EXPIRY TIME";
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- ...
- ...
- ...
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b election/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin election/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
Yusuf Lateef - Connect via Messenger - [email protected] [email protected]
Project Link: https://github.com/BigYusuf/election
Here are the list of resources I find helpful and would like to give credit to.