{"id":24299137,"url":"https://github.com/ilham-muttaqien17/boiler-fastify-typeorm","last_synced_at":"2026-04-18T12:02:05.187Z","repository":{"id":272550045,"uuid":"916973924","full_name":"Ilham-muttaqien17/boiler-fastify-typeorm","owner":"Ilham-muttaqien17","description":"Boilerplate powered by Fastify, Typescript, \u0026 TypeORM","archived":false,"fork":false,"pushed_at":"2025-05-25T15:19:22.000Z","size":366,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-24T12:49:09.107Z","etag":null,"topics":["fastify","postgres","typeorm","typescript"],"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/Ilham-muttaqien17.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,"zenodo":null}},"created_at":"2025-01-15T05:32:42.000Z","updated_at":"2025-05-25T16:42:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"0e459a71-8585-4411-8435-8e7f6522b5a8","html_url":"https://github.com/Ilham-muttaqien17/boiler-fastify-typeorm","commit_stats":null,"previous_names":["ilham-muttaqien17/boiler-fastify-typeorm"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/Ilham-muttaqien17/boiler-fastify-typeorm","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilham-muttaqien17%2Fboiler-fastify-typeorm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilham-muttaqien17%2Fboiler-fastify-typeorm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilham-muttaqien17%2Fboiler-fastify-typeorm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilham-muttaqien17%2Fboiler-fastify-typeorm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Ilham-muttaqien17","download_url":"https://codeload.github.com/Ilham-muttaqien17/boiler-fastify-typeorm/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Ilham-muttaqien17%2Fboiler-fastify-typeorm/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31967993,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["fastify","postgres","typeorm","typescript"],"created_at":"2025-01-16T21:18:52.225Z","updated_at":"2026-04-18T12:02:05.134Z","avatar_url":"https://github.com/Ilham-muttaqien17.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boilerplate Fastify TypeORM\n\nA boilerplate for building REST APIs using **Fastify**, **TypeORM**, and **TypeScript**.\n\n## Table of Contents\n\n- [Pre-requirements](#pre-requirements)\n- [Installation](#installation)\n- [Scripts](#scripts)\n- [Usage](#usage)\n\n## Pre-requirements\n\nBefore running this application, ensure you have the following installed and configured on your system:\n\n1. **Redis**: \n   - Redis is used for caching or queue management.\n   - Installation guide: [Redis Official Documentation](https://redis.io/docs/getting-started/installation/)\n\n2. **PostgreSQL**:\n   - The application uses PostgreSQL as the primary database.\n   - Installation guide: [PostgreSQL Official Documentation](https://www.postgresql.org/download/)\n\nEnsure both services are running and accessible before proceeding with the installation steps.\n\n## Installation\n\n1. **Clone the repository**:\n   ```bash\n   git clone https://github.com/Ilham-muttaqien17/boiler-fastify-typeorm\n   cd boiler-fastify-typeorm\n   ```\n2. **Install dependencies**:\n    ```bash\n    npm install\n    ```\n3. **Environment Configuration**:\n\n    Copy the `config/.env.example` file to `config/.env` to configure your environment variables.\n\n\n## Scripts\n\n| Command                                                                   | Description                                               |\n|---------------------------------------------------------------------------|-----------------------------------------------------------|\n| `npm run prepare`                                                         | Sets up git hooks using `simple-git-hooks`.               |\n| `npm run typecheck`                                                       | Perform type checking on each TypeScript file.           |\n| `npm run dev`                                                             | Starts the app in development mode with TypeScript.       |\n| `npm run build`                                                           | Cleans the `dist` directory and compiles TypeScript files.|\n| `npm start`                                                               | Starts the app in production mode with module aliasing.   |\n| `npm run lint`                                                            | Lints TypeScript files using ESLint.                      |\n| `npm run commitlint`                                                      | Lints commit messages.                                    |\n| `npm run entity:create ./src/db/entities/\u003cyour_entity_name\u003e.ts`           | Creates a new TypeORM entity.                             |\n| `npm run migration:create ./src/db/migrations/\u003cyour_migration_name\u003e.ts`   | Creates a new TypeORM migration file.                     |\n| `npm run migration:generate ./src/db/migrations/\u003cyour_migration_name\u003e.ts` | Generates a migration file based on schema changes.       |\n| `npm run migration:run`                                                   | Runs all pending TypeORM migrations.                      |\n| `npm run migration:revert`                                                | Reverts the last executed migration.                      |\n| `npm run migration:show`                                                  | Displays the status of all migrations.                    |\n| `npm run seed:create ./src/db/seeds/\u003cyour_seeder_name\u003e.ts`                | Creates a new database seed file.                         |\n| `npm run seed:run`                                                        | Executes all seed files to populate the database.         |\n| `npm run seed:revert`                                                     | Reverts the last seed operation.                          |\n| `npm run db:create`                                                       | Creates the database specified in the configuration.      |\n| `npm run db:drop`                                                         | Drops the specified database.                             |\n| `npm run db:refresh`                                                      | Drops and recreates the database.                         |\n\n\n## Usage\n\n### Database Setup\n\nBefore using the application, you need to create the database. This can be done using the following command:\n\n```bash\nnpm run db:create\n```\n\n### Development Mode\n\nTo run the application in development mode, use the following command:\n\n```bash\nnpm run dev\n```\n\n### Production Mode\n\nTo run the application in production mode, use the following command:\n1. **Build the application**:\n   ```bash\n   npm run build\n   ```\n2. **Start the application**:\n   ```bash\n   npm run start\n   ```\n\nThe app will be available at `http://localhost:3300` by default.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filham-muttaqien17%2Fboiler-fastify-typeorm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Filham-muttaqien17%2Fboiler-fastify-typeorm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Filham-muttaqien17%2Fboiler-fastify-typeorm/lists"}