{"id":21762848,"url":"https://github.com/lccodder/fastify-typescript-boilerplate","last_synced_at":"2026-01-08T02:55:26.985Z","repository":{"id":231782141,"uuid":"781467071","full_name":"LCcodder/fastify-typescript-boilerplate","owner":"LCcodder","description":"REST API boilerplate Notion clone written with Fastify, TypeScript and PostgreSQL","archived":false,"fork":false,"pushed_at":"2024-07-30T23:04:41.000Z","size":459,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-07-30T23:52:50.712Z","etag":null,"topics":["architecture","backend-api","boilerplate","boilerplate-template","clean-architecture","fastify","nodejs","rest","rest-api","template","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LCcodder.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2024-04-03T12:45:17.000Z","updated_at":"2024-07-30T23:52:53.162Z","dependencies_parsed_at":"2024-04-15T12:59:52.164Z","dependency_job_id":"aa7fa83d-fb9b-43b1-a057-cf586dcac585","html_url":"https://github.com/LCcodder/fastify-typescript-boilerplate","commit_stats":null,"previous_names":["lccodder/nodenotes","lccodder/fastify-typescript-boilerplate"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LCcodder%2Ffastify-typescript-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LCcodder%2Ffastify-typescript-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LCcodder%2Ffastify-typescript-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LCcodder%2Ffastify-typescript-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LCcodder","download_url":"https://codeload.github.com/LCcodder/fastify-typescript-boilerplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246351016,"owners_count":20763232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["architecture","backend-api","boilerplate","boilerplate-template","clean-architecture","fastify","nodejs","rest","rest-api","template","typescript"],"created_at":"2024-11-26T12:13:19.055Z","updated_at":"2026-01-08T02:55:26.953Z","avatar_url":"https://github.com/LCcodder.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `Node.js` and `Fastify` **RESTful API** boilerplate\n![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge\u0026logo=node.js\u0026logoColor=white)\n![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge\u0026logo=typescript\u0026logoColor=white)\n![Fastify](https://img.shields.io/badge/fastify-%23000000.svg?style=for-the-badge\u0026logo=fastify\u0026logoColor=white)\n![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge\u0026logo=postgresql\u0026logoColor=white)\n![Redis](https://img.shields.io/badge/redis-%23DD0031.svg?style=for-the-badge\u0026logo=redis\u0026logoColor=white)\n\n![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge\u0026logo=jest\u0026logoColor=white)\n![Postman](https://img.shields.io/badge/Postman-FF6C37?style=for-the-badge\u0026logo=postman\u0026logoColor=white)\n![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge\u0026logo=swagger\u0026logoColor=white)\n![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge\u0026logo=docker\u0026logoColor=white)\n![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge\u0026logo=githubactions\u0026logoColor=white)\n### REST API and *Clean Architecture* boilerplate/template written in `Node.js` and `Fastify`\n This is *notion-like* note application backend and *Clean Architecture boilerplate* with registration, authorization, collaborating, etc. You can create note, add tags to it and filter your notes, add and remove collaborators, customize your profile.\n\n### **Features**\n+ User registration and authorization by `JWT`\n+ User's profile update\n+ User password change\n+ Note creation with tags and collaborators\n+ Note edit\n+ Receiving notes with pagination, update date sorting, tags filtering\n+ Adding and removing collaborators\n\n\n\n\n## **How to launch**\n\u003e To launch application you need to install `Docker` and `Docker Compose` on your system\n\n1. Clone git repository and go to the directory\n``` Shell\ngit clone https://github.com/LCcodder/NodeNotes\ncd NodeNotes\n```\n2. Edit environment variables in `docker-compose.yaml` as you want \n3. Run \n```Shell\ndocker compose up --build\n```\n\n## **Environment variables**\n\n1. `DATABASE_HOST`\n2. `DATABASE_NAME`\n3. `DATABASE_USER`\n4. `DATABASE_PASSWORD`\n5. `REDIS_CONNECTION_STRING` (ex. `redis://127.0.0.1:6379/0`)\n6. `JWT_SECRET`\n7. `JWT_EXPIRATION` (ex. `24h`)\n8. `PORT` \n\n## **`Jest` unit tests**\n- App covered with `Jest` unit tests\n- Coverage `85%`\n\nTo run all testsheets enter:\n```\nnpm test\n```\n\n## **`Postman` e2e tests**\n\n+ App covered with e2e tests\n+ `100%` coverage, over 280 tests\n\nYou can find testsheets in `tests/e2e/api_v1.postman_collection.json`\n\n## **`pgAdmin` panel** \n\n1. Go to the `http://localhost:5050`\n2. Log in with email: `admin@pgadmin.com` and password: `password`\n3. Run\n```\ndocker ps -a \n```\n4. Find and copy `postgres` container id\n5. Run\n```\ndocker inspect \u003ccopied container id\u003e\n```\n6. Find `IPAddress` with *172* prefix and copy it\n7. Now add server in `pgAdmin` and paste copied IP in `host` input\n8. Complete all other inputs\n## **`Swagger` API specification**\n#### WebApp supports `Swagger` `OpenApi` spec viewer\n#### Use `http://localhost:8080/documentation` to go to the `SwaggerUI` page \n\u003cimg src=\"screenshot.png\"\u003e\n\n---\n### Everything, including `Postman` tests, unit tests, `GitHub ci/cd`, `Docker compose` and API itself was created and written by [LCcodder](https://github.com/LCcodder)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flccodder%2Ffastify-typescript-boilerplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flccodder%2Ffastify-typescript-boilerplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flccodder%2Ffastify-typescript-boilerplate/lists"}