Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rodrigofontesdev/polls
Real-time voting system built with Node.js.
https://github.com/rodrigofontesdev/polls
fastify nodejs postgresql prisma redis typescript websockets
Last synced: 3 days ago
JSON representation
Real-time voting system built with Node.js.
- Host: GitHub
- URL: https://github.com/rodrigofontesdev/polls
- Owner: rodrigofontesdev
- License: mit
- Created: 2024-02-09T00:52:30.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-14T02:45:54.000Z (11 months ago)
- Last Synced: 2024-11-11T06:20:01.293Z (2 months ago)
- Topics: fastify, nodejs, postgresql, prisma, redis, typescript, websockets
- Language: TypeScript
- Homepage:
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Polls
A real-time voting system where users can create a poll and other users can cast their votes. The system generates a ranking among the options and updates the votes in real-time.
## Prerequisites
- Node.js
- Docker
- Git
## Getting Started
- Clone the repository (`git clone [email protected]:rodrigofontesdev/polls.git`)
- Install dependencies (`npm install`)
- Setup PostgreSQL and Redis (`docker compose up -d`)
- Check if PostgreSQL and Redis containers is running (`docker ps`)
- Copy .env.example file (`cp .env.example .env`)
- Install database migrations (`npx prisma migrate dev`)
- Run application (`npm run dev`)
- Test it! (I personally recommend testing with [Hoppscotch](https://hoppscotch.io))
## Prisma Studio
Prisma Studio is a visual editor for the data in your database.
- Run in your terminal (`npx prisma studio`)
- Visit (`http://localhost:5555`)
## Hoppscotch
Hoppscotch is an open-source API development ecosystem that helps you create and test your API requests.
### Setup
- Install the **Hoppscotch Browser Extension** ([Read more here](https://docs.hoppscotch.io/documentation/getting-started/setup#locally-served-apis))
- Open two tabs on browser for Hoppscotch, select **REST** and **Realtime** options in each tab
- Authorization: No Auth
## How to use
### HTTP
### POST `/polls`
Create a new poll.
**Request body**
```json
{
"title": "What's the best programming language?",
"options": [
"JavaScript",
"PHP",
"Python",
"C#"
]
}
```
**Response body**
```json
{
"pollId": "4f111485-be0c-41d5-8f2a-cb9e8933cd2f"
}
```
### GET `/polls/:pollId`
Return data from a single poll.
**Request body**
`No request body`
**Response body**
```json
{
"poll": {
"id": "4f111485-be0c-41d5-8f2a-cb9e8933cd2f",
"title": "What's the best programming language?",
"options": [
{
"id": "3ef7ed4d-0064-4c95-9788-b96033fc1755",
"title": "JavaScript",
"score": 0
},
{
"id": "bfc8a311-0c9a-4753-b1a3-eebfd1fd1480",
"title": "PHP",
"score": 0
},
{
"id": "0ea30528-14be-4465-b810-b79eb8211ed8",
"title": "Python",
"score": 0
},
{
"id": "337298a6-f7b7-4334-8b6b-9c8d17b697c2",
"title": "C#",
"score": 0
}
]
}
}
```
### POST `/polls/:pollId/votes`
Add a vote to specific poll.
**Request body**
```json
{
"pollOptionId": "3ef7ed4d-0064-4c95-9788-b96033fc1755"
}
```
**Response body**
`No response body`
### WebSockets
### ws `/polls/:pollId/results`
Return votes in realtime on a specific poll.
**Response body**
```json
{
"pollOptionId": "3ef7ed4d-0064-4c95-9788-b96033fc1755",
"votes": 1
}
```
## Built With
- Node.js
- Typescript
- Redis
- PostgreSQL
- WebSockets
## License
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/rodrigofontesdev/polls/blob/main/LICENSE.md) file for details.