{"id":26670445,"url":"https://github.com/CaioHPerlin/rest-api-express-template","last_synced_at":"2025-12-30T20:33:31.456Z","repository":{"id":282788342,"uuid":"948146526","full_name":"CaioHPerlin/express-ts-boilerplate","owner":"CaioHPerlin","description":"Simple development-ready Express + TypeScript REST API template!","archived":false,"fork":false,"pushed_at":"2025-03-25T07:53:01.000Z","size":53,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-25T08:34:34.776Z","etag":null,"topics":["api","backend","boilerplate","eslint","express","folder-structure","node","nodejs","rest","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CaioHPerlin.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-03-13T20:35:05.000Z","updated_at":"2025-03-25T07:53:05.000Z","dependencies_parsed_at":"2025-03-17T04:46:02.716Z","dependency_job_id":null,"html_url":"https://github.com/CaioHPerlin/express-ts-boilerplate","commit_stats":null,"previous_names":["caiohperlin/express-ts-template"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaioHPerlin%2Fexpress-ts-boilerplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaioHPerlin%2Fexpress-ts-boilerplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaioHPerlin%2Fexpress-ts-boilerplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CaioHPerlin%2Fexpress-ts-boilerplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CaioHPerlin","download_url":"https://codeload.github.com/CaioHPerlin/express-ts-boilerplate/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245551707,"owners_count":20634067,"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":["api","backend","boilerplate","eslint","express","folder-structure","node","nodejs","rest","template","typescript"],"created_at":"2025-03-25T22:23:49.156Z","updated_at":"2025-12-30T20:33:31.423Z","avatar_url":"https://github.com/CaioHPerlin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express + Typescript REST API Boilerplate\n\nThis repository provides a basic structure for building REST APIs using Express and TypeScript. It includes essential configurations and dependencies required to help you get started quickly and securely.\n\n## Features\n\n- Express server setup with TypeScript\n- Basic middleware configuration (CORS, JSON parsing, Global Error Handler)\n- Support for Custom Errors\n- Pre-configured ESLint and Prettier for code quality and formatting\n- Environment variable management with `dotenv`\n- Basic folder structure for organizing and versioning your API\n\n## Getting Started\n\n### Prerequisites\n\n- Node.js (v14 or higher)\n- npm or yarn\n\n### Installation\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/your-username/express-ts-boilerplate.git\n   cd express-ts-boilerplate\n   ```\n\n2. Install dependencies:\n\n    ```bash\n   npm install\n    # or\n    yarn install\n   ```\n\n3. Create a `.env` file in the root directory and add your environment variables:\n\n   ```bash\n   PORT=5000\n   NODE_ENV=development\n   DEBUG=false\n   ```\n\n### Running the Server\n\n```bash\nnpm run dev\n# or \nyarn dev\n```\n\nThe server will be running on `http://localhost:5000`.\n\n### Building the Project\n\nTo build the project, run:\n\n```bash \nnpm run build\n# or\nyarn build\n```\nThe compiled files will be located in the **dist** directory.\n\n### Linting\nTo lint your code and automatically fix issues, run:\n\n```bash\nnpm run lint\n# or \nyarn lint\n```\n\n## Project Structure\n\n```\nexpress-ts-boilerplate/\n├── dist/                   # Compiled files\n├── node_modules/           # Node.js modules\n├── src/                    # Source files\n│   ├── api/                # API related files\n│   │   ├── v1/             # Version 1 of the API\n│   │   │   ├── controllers/\n│   │   │   ├── interfaces/\n│   │   │   ├── models/\n│   │   │   ├── repositories/\n│   │   │   ├── routes/\n│   │   │   └── services/\n│   ├── config/             # Configuration files\n│   │   └── db.ts           # Database configuration\n│   ├── errors/             # Custom error classes\n│   ├── middleware/         # Custom middleware\n│   ├── utils/              # Utility functions\n│   └── app.ts              # Main application file\n├── .gitignore              # Git ignore file\n├── .prettierrc             # Prettier configuration\n├── .prettierignore         # Prettier ignore file\n├── eslint.config.mjs       # ESLint configuration\n├── package.json            # NPM package configuration\n├── tsconfig.json           # TypeScript configuration\n└── README.md               # Project documentation\n```\n\n## Contributing\nFeel free to fork this repository and make your own changes. Pull requests are welcome!\n\n## License\n\nThis project is licensed under the **ISC License.**\n\n\u003cbr\u003e\n\n\u003e Thank you for reading and happy *express*-ing! 👾\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCaioHPerlin%2Frest-api-express-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCaioHPerlin%2Frest-api-express-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCaioHPerlin%2Frest-api-express-template/lists"}