Skip to content

bpajor/PolElections2023-rest-api

Repository files navigation

Nest Logo

A progressive Node.js framework for building efficient and scalable server-side applications.

NPM Version Package License NPM Downloads CircleCI Discord Backers on Open Collective Sponsors on Open Collective Support us

Poland Elections 2023 REST API

🛠️ Stack

  • Nest.js
  • Node.js
  • TypeScript
  • Mongoose
  • JWT Authentication

✨ Features

  1. Access JWT token
  2. Access information on individual candidates.
  3. Retrieve results of electoral committees in specific districts or territorial units.
  4. Use specified filters to select data which you need

🚀 Online Access

Experience the API live here.

📘 Swagger Documentation

Explore the API using Swagger here.

Swagger Documentation Screenshot

⚙️ Installation

To run the project locally, follow these steps:

# Clone the repository
git clone https://github.com/bpajor/PolElections2023-rest-api.git

# Navigate to the project folder
cd PolElections2023-rest-api

# Install dependencies
npm install

Now you should change the start:dev value in package.json to

SET URI=[Uri you can access from mongodb]&&nest start
# Start server
npm run start:dev

🌟 Additional Information

This project leverages the powerful Nest.js framework, ensuring scalability and maintainability. The integration of JWT authentication ensures secure access to election data, while TypeScript enhances code readability and maintainability.

Feel free to contribute to the project and help make election data accessible and understandable for everyone.

For any issues or suggestions, please create an issue.

Happy coding! 🚀

📜 License

This project is licensed under the MIT License.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published