https://github.com/erxiahq/govote-api
Simple Node.js API to help people find locations to get PVCs and Vote in the upcoming Nigeria General Elections.
https://github.com/erxiahq/govote-api
elections knex koajs nigeria nodejs
Last synced: 6 months ago
JSON representation
Simple Node.js API to help people find locations to get PVCs and Vote in the upcoming Nigeria General Elections.
- Host: GitHub
- URL: https://github.com/erxiahq/govote-api
- Owner: ErxiaHQ
- License: mit
- Created: 2018-02-03T13:53:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-14T13:36:49.000Z (over 7 years ago)
- Last Synced: 2025-03-25T21:13:22.362Z (6 months ago)
- Topics: elections, knex, koajs, nigeria, nodejs
- Language: JavaScript
- Homepage: https://govote.org.ng
- Size: 61.5 KB
- Stars: 15
- Watchers: 2
- Forks: 5
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# govote-api
Simple Node.js API to help people find locations to get PVCs and Vote in the upcoming Nigeria General Elections.
## Requirements
To run locally, you would need the following installed:
1. [MySQL](https://www.mysql.com/)
2. [Node.js and NPM](https://nodejs.org/en/)
## Getting Started
1. Install required dependencies - `npm install`
2. Copy `.env.example` to `.env`. Remember to edit in your own credentials - `cp .env.example .env`.
3. Run migrations with knex - `node_modules/.bin/knex migrate:latest`
4. Seed database - `node_modules/.bin/knex seed:run`
5. Start server - `node app.js` or `nodemon app.js`
## Todo
- Documentation
- Tests
- Implement [Election Candidates feature](https://twitter.com/Itz_Matti/status/960340741871595523)
- Log all searches from clients
## Contributing
The #1 contribution you could make is to share, and tell people about govote.
View the [Contribution Guide](https://github.com/ErxiaHQ/govote-api/blob/master/CONTRIBUTING.md) for how to contribute.