{"id":38452223,"url":"https://github.com/andrebeolchi/postech-api","last_synced_at":"2026-01-17T04:49:08.794Z","repository":{"id":271794156,"uuid":"914113445","full_name":"andrebeolchi/postech-api","owner":"andrebeolchi","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-09T22:41:26.000Z","size":60,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-01-09T23:25:42.623Z","etag":null,"topics":["api","backend","express","nodejs","posts"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrebeolchi.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-01-09T01:23:10.000Z","updated_at":"2025-01-09T22:24:17.000Z","dependencies_parsed_at":"2025-01-09T23:25:47.875Z","dependency_job_id":"b32100dc-a919-4613-b451-f3186799ff94","html_url":"https://github.com/andrebeolchi/postech-api","commit_stats":null,"previous_names":["andrebeolchi/postech-api"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/andrebeolchi/postech-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrebeolchi%2Fpostech-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrebeolchi%2Fpostech-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrebeolchi%2Fpostech-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrebeolchi%2Fpostech-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrebeolchi","download_url":"https://codeload.github.com/andrebeolchi/postech-api/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrebeolchi%2Fpostech-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28496590,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-17T04:31:57.058Z","status":"ssl_error","status_checked_at":"2026-01-17T04:31:45.816Z","response_time":85,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","backend","express","nodejs","posts"],"created_at":"2026-01-17T04:49:08.078Z","updated_at":"2026-01-17T04:49:08.780Z","avatar_url":"https://github.com/andrebeolchi.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"https://img.shields.io/endpoint?url=https://postech-api.onrender.com/status-badge\"/\u003e\n\n# PosTech\n## Description\nThis is a simple API that allows you to CRUD posts.\n\n## Installation\n1. Clone the repository \n2. Run `yarn install` to install the dependencies\n3. Run `docker-compose up` to start the database \n   - (I recommend using `docker-compose up -d` to run in the background)\n4. Run `yarn dev` to start the server\n\n\u003cbr\u003e\n\n\u003e [!IMPORTANT]  \n\u003e Remember to create a `.env` file using the `.env.example` as a template\n\n## Next Steps\n- [X] Create the project structure\n- [X] Add Docker support\n- [X] Install and configure Prisma ORM\n- [X] Create the database schema\n- [X] Create the CRUD operations for the posts\n- [X] Add CI/CD (GitHub Actions)\n- [X] Add custom error handling\n- [ ] Record a video showing how to use the API\n\n## Endpoints\n- GET `/posts` - Get all posts\n- GET `/posts/:id` - Get a post by id\n- POST `/posts` - Create a new post\n- PUT `/posts/:id` - Update a post by id\n- DELETE `/posts/:id` - Delete a post by id\n- GET `/posts/search` - Get posts by query\n\n## Tests\nTo run the tests, run `yarn test`\n\n## Folder Structure\n`src/` - Contains the source code\n\u003cbr\u003e├ `adapters/` - Contains the adapters that are responsible for abstracting external libraries and services\n\u003cbr\u003e├ `controllers/` - Contains the controllers that are responsible for handling the requests and responses\n\u003cbr\u003e├ `repositories/` - Contains the repositories are responsible for handling the database operations\n\u003cbr\u003e├ `routes/` - Contains the routes are responsible for defining the API routes\n\u003cbr\u003e├ `services/` - Contains the services are responsible for handling the business logic and calling the repositories\n\u003cbr\u003e├ `app.ts` - The file that configures the application, adding the routes, middlewares and/or other configurations (like error handling)\n\u003cbr\u003e├ `server.ts` - The file that starts the server\n\n## Technologies\n- Node.js\n- Express\n- Prisma ORM (PostgreSQL)\n- Docker\n- Jest\n- TypeScript\n\n## Author\n\u003cimg src=\"https://avatars.githubusercontent.com/u/61586777\" width=\"16\" height=\"16\"\u003e [André Beolchi](https://github.com/andrebeolchi) (RM 359648)\n\u003cbr\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/34667580\" width=\"16\" height=\"16\"\u003e [Fellipe Corominas](https://github.com/LeFelps) (RM 359677)\n\n\u003cbr\u003e Happy coding! 🚀","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrebeolchi%2Fpostech-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrebeolchi%2Fpostech-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrebeolchi%2Fpostech-api/lists"}