https://github.com/bigyusuf/election
This is a RESTFUL API which all elections in Nigeria from 2014 will be compiled and serve through some unique endpoints.
https://github.com/bigyusuf/election
api-rest election election-api express governorship-election jwt-authentication mongodb nigerian-states nodejs presidential-election rapidapi
Last synced: 2 months ago
JSON representation
This is a RESTFUL API which all elections in Nigeria from 2014 will be compiled and serve through some unique endpoints.
- Host: GitHub
- URL: https://github.com/bigyusuf/election
- Owner: BigYusuf
- License: mit
- Created: 2022-07-15T11:29:05.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-25T11:17:24.000Z (over 3 years ago)
- Last Synced: 2026-01-03T16:22:41.166Z (5 months ago)
- Topics: api-rest, election, election-api, express, governorship-election, jwt-authentication, mongodb, nigerian-states, nodejs, presidential-election, rapidapi
- Language: JavaScript
- Homepage: https://rapidapi.com/BigYusuf/api/election3
- Size: 573 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## About The Project
[![RapidAPI Url][product-screenshot]](https://rapidapi.com/BigYusuf/api/election3)
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.
[![Mobile screen][product-screenshot2]](https://rapidapi.com/BigYusuf/api/election3)
### Built With
Here are the list of major frameworks/ libraries used to bootstrap this project
- [Express.js](https://expressjs.org/)
- [Node.js](https://nodejs.org/)
- [MongoDB](https://www.mongodb.com/)
- [JSON Web Token (JWT)](https://jwt.io/)
- [Axios](https://axios-http.com/docs/intro)
### Features
#### Database storage (MongoDB)
[![Sample Database][product-screenshot4]](https://rapidapi.com/BigYusuf/api/election3)
#### Deployed to RapidAPI
[![Mobile][product-screenshot5]](https://rapidapi.com/BigYusuf/api/election3)
#### Authenticated Admin with JWT
[![Mobile][product-screenshot7]](https://rapidapi.com/BigYusuf/api/election3)
#### Cool RestFul Endpoints
[![Mobile][product-screenshot6]](https://rapidapi.com/BigYusuf/api/election3)
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
- npm
```sh
npm install npm@latest -g
```
### Installation
_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._
1. Clone the repo
```sh
git clone https://github.com/BigYusuf/election.git
```
2. Install NPM packages
```sh
npm install
```
3. Enter your KEYS in `.env`
```javascript
NODE_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";
```
## Usage
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](https://example.com)_
## Roadmap
- [ ] ...
- [ ] ...
- [ ] ...
See the [open issues](https://github.com/BigYusuf/election/issues) for a full list of proposed features (and known issues).
## Contributing
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!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b election/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin election/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Yusuf Lateef - [Connect via Messenger](http://m.me/Bigyusufff/) - election0000@gmail.com mystik5551@gmail.com
Project Link: [https://github.com/BigYusuf/election](https://github.com/BigYusuf/election)
## Acknowledgments
Here are the list of resources I find helpful and would like to give credit to.
- [INEC Official Website](https://www.youtube.com)
- [INEC 2019 Presidential Election](https://www.inecnigeria.org/wp-content/uploads/2019/03/02019-GE-PRESIDENTIAL-ELECTION-RESULTS.pdf)
- [2019 General Election Wikipedia](https://en.wikipedia.org/wiki/2019_Nigerian_general_election)
- [2019 General Election BBC News](https://www.bbc.co.uk/news/resources/idt-f0b25208-4a1d-4068-a204-940cbe88d1d3)
- [Best ReadMe Template](https://github.com/othneildrew/Best-README-Template)
[contributors-shield]: https://img.shields.io/github/contributors/BigYusuf/Best-README-Template.svg?style=for-the-badge
[contributors-url]: https://github.com/BigYusuf/election/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/BigYusuf/election.svg?style=for-the-badge
[forks-url]: https://github.com/BigYusuf/election/network/members
[stars-shield]: https://img.shields.io/github/stars/BigYusuf/election.svg?style=for-the-badge
[stars-url]: https://github.com/BigYusuf/election/stargazers
[issues-shield]: https://img.shields.io/github/issues/BigYusuf/election
[issues-url]: https://github.com/BigYusuf/election/issues
[license-shield]: https://img.shields.io/github/license/BigYusuf/election.svg?style=for-the-badge
[license-url]: https://github.com/BigYusuf/election/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/bigyusufff
[product-screenshot]: images/rap3.PNG
[product-screenshot2]: images/mongodbelection.PNG
[product-screenshot3]: images/emailsample.png
[product-screenshot4]: images/mongodbelection.PNG
[product-screenshot5]: images/mobilemode2.png
[product-screenshot6]: images/alanstudio.png
[product-screenshot7]: images/login.png
