https://github.com/andrebeolchi/postech-api
https://github.com/andrebeolchi/postech-api
api backend express nodejs posts
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/andrebeolchi/postech-api
- Owner: andrebeolchi
- Created: 2025-01-09T01:23:10.000Z (over 1 year ago)
- Default Branch: develop
- Last Pushed: 2025-01-09T22:41:26.000Z (over 1 year ago)
- Last Synced: 2025-01-09T23:25:42.623Z (over 1 year ago)
- Topics: api, backend, express, nodejs, posts
- Language: TypeScript
- Homepage:
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# PosTech
## Description
This is a simple API that allows you to CRUD posts.
## Installation
1. Clone the repository
2. Run `yarn install` to install the dependencies
3. Run `docker-compose up` to start the database
- (I recommend using `docker-compose up -d` to run in the background)
4. Run `yarn dev` to start the server
> [!IMPORTANT]
> Remember to create a `.env` file using the `.env.example` as a template
## Next Steps
- [X] Create the project structure
- [X] Add Docker support
- [X] Install and configure Prisma ORM
- [X] Create the database schema
- [X] Create the CRUD operations for the posts
- [X] Add CI/CD (GitHub Actions)
- [X] Add custom error handling
- [ ] Record a video showing how to use the API
## Endpoints
- GET `/posts` - Get all posts
- GET `/posts/:id` - Get a post by id
- POST `/posts` - Create a new post
- PUT `/posts/:id` - Update a post by id
- DELETE `/posts/:id` - Delete a post by id
- GET `/posts/search` - Get posts by query
## Tests
To run the tests, run `yarn test`
## Folder Structure
`src/` - Contains the source code
├ `adapters/` - Contains the adapters that are responsible for abstracting external libraries and services
├ `controllers/` - Contains the controllers that are responsible for handling the requests and responses
├ `repositories/` - Contains the repositories are responsible for handling the database operations
├ `routes/` - Contains the routes are responsible for defining the API routes
├ `services/` - Contains the services are responsible for handling the business logic and calling the repositories
├ `app.ts` - The file that configures the application, adding the routes, middlewares and/or other configurations (like error handling)
├ `server.ts` - The file that starts the server
## Technologies
- Node.js
- Express
- Prisma ORM (PostgreSQL)
- Docker
- Jest
- TypeScript
## Author
[André Beolchi](https://github.com/andrebeolchi) (RM 359648)
[Fellipe Corominas](https://github.com/LeFelps) (RM 359677)
Happy coding! 🚀