https://github.com/max-im/polls-crud
This project provides a simple CRUD (Create, Read, Update, Delete) API for managing polls. Users can create new polls, retrieve existing polls, update polls, and delete polls. The API also supports searching polls by their question field and includes plans for pagination and other features.
https://github.com/max-im/polls-crud
docker docker-compose express mongodb nodejs typescript
Last synced: 2 months ago
JSON representation
This project provides a simple CRUD (Create, Read, Update, Delete) API for managing polls. Users can create new polls, retrieve existing polls, update polls, and delete polls. The API also supports searching polls by their question field and includes plans for pagination and other features.
- Host: GitHub
- URL: https://github.com/max-im/polls-crud
- Owner: Max-im
- Created: 2024-12-14T14:31:19.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-16T04:25:12.000Z (over 1 year ago)
- Last Synced: 2025-02-08T10:45:54.745Z (over 1 year ago)
- Topics: docker, docker-compose, express, mongodb, nodejs, typescript
- Language: TypeScript
- Homepage:
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Polls CRUD
This project provides a simple CRUD (Create, Read, Update, Delete) API for managing polls. Users can create new polls, retrieve existing polls, update polls, and delete polls. The API also supports searching polls by their question field and includes plans for pagination and other features.
## Tech
- Node.js
- Express.js
- MongoDB
- TypeScript
## Postman
- [Postman Collection](./postman/polls.postman_collection.json)
- [Postman Environment](./postman/polls.postman_environment.json)
## Polls API
Method | Endpoint | Description
------ | ---------- | ------------------------------------------
POST | /polls | Create a new poll
GET | /polls | Get all polls (with search and pagination)
GET | /polls/:id | Get a specific poll by ID
PUT | /polls/:id | Update a specific poll
DELETE | /polls/:id | Delete a specific poll
## Development
- Clone this repository in the current folder:
```sh
git clone https://github.com/Max-im/polls-crud.git .
```
- Make sure your current Node.js version is 18 or higher:
```sh
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
nvm use 18
```
- Run the command:
```sh
npm run dev
```
## Production
- Run the command:
```sh
docker-compose up
```