{"id":26264342,"url":"https://github.com/suman7802/expresstemplate","last_synced_at":"2025-12-29T14:33:26.137Z","repository":{"id":281488995,"uuid":"943875270","full_name":"suman7802/ExpressTemplate","owner":"suman7802","description":"Express Template","archived":false,"fork":false,"pushed_at":"2025-03-09T13:13:39.000Z","size":88,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-09T13:27:02.888Z","etag":null,"topics":["express","helmet","i18next","localization","morgan","ratelimiter","typescript","winston","zod"],"latest_commit_sha":null,"homepage":"https://express-template-vm47.onrender.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/suman7802.png","metadata":{"files":{"readme":"readme.md","changelog":"Changes.md","contributing":null,"funding":null,"license":"LICENSE","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-06T12:09:34.000Z","updated_at":"2025-03-09T13:13:43.000Z","dependencies_parsed_at":"2025-03-09T14:30:34.848Z","dependency_job_id":null,"html_url":"https://github.com/suman7802/ExpressTemplate","commit_stats":null,"previous_names":["suman7802/expresstemplate"],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suman7802%2FExpressTemplate","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suman7802%2FExpressTemplate/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suman7802%2FExpressTemplate/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suman7802%2FExpressTemplate/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suman7802","download_url":"https://codeload.github.com/suman7802/ExpressTemplate/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243510122,"owners_count":20302294,"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":["express","helmet","i18next","localization","morgan","ratelimiter","typescript","winston","zod"],"created_at":"2025-03-14T02:14:46.306Z","updated_at":"2025-12-29T14:33:26.128Z","avatar_url":"https://github.com/suman7802.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Express template\n\n## **Getting started**\n\nTo get started with this project, follow the steps below:\n\n**Prerequisites**\n\n- Ensure you have Node.js installed. You can download it from [Node.js official website](https://nodejs.org/).\n- Install Git from [Git official website](https://git-scm.com/).\n- Typescript installed globally. You can install it by running `npm install -g typescript`.\n\n**Steps**\n\n1. **Clone the repository**\n\n    ```bash\n    git clone git@github.com:suman7802/ExpressTemplate.git\n    ```\n\n2. **Navigate to the project directory**\n\n    ```bash\n    cd ExpressTemplate\n    ```\n\n3. **Install dependencies**\n\n    ```bash\n    npm install\n    ```\n\n4. **Create .env.local file**\n\n    Create a `.env.local` file in the root of the project and add the environment variables, using env.example file.\n\n5. **Run the development server**\n\n    ```bash\n    npm run dev\n    ```\n\n6. **Open the project in your browser**\n\n    Open your browser and go to `http://localhost:8080` to see the project running.\n\nBy following these steps, you will have the project up and running on your local machine.\n\nFor createing build files run `npm run build` and for running build files run `npm start`.\n\n# **Documentation**\n\n\u003e [Postman Collection](https://documenter.getpostman.com/view/27265804/2sAYkBsM99)\n\n# **Docker compose**\n\n### The project is equipped with a docker-compose file for easy deployment and monitoring with Grafana and Prometheus.\n\n\u003e To run the project using Docker, follow these steps:\n\n```bash\ndocker-compose up\n```\n\n# **Features**\n\n- Custom error class\n- Custom error handler\n- Logging\n- Localization\n- Rate limiting\n- Slow down\n- Multer\n- API key emplemantation\n- Sending Emails (sendgrid)\n- local email templates (handlebars)\n- Metrics (Analytics)\n- Prometheus (containerized)\n- Grafana (containerized)\n- Conterization\n\n# Features to be added\n\n- Testing\n- Authentication (passport.js)\n- Authorization\n- Grafana Loki\n\n## Contributing\n\nContributors are welcome! If you'd like to enhance the project further or add new features, please follow these steps:\n\n1. Fork the repository.\n2. Clone your forked repository:\n    ```bash\n     git clone git@github.com:suman7802/ExpressTemplate.git\n    ```\n3. Create a new branch:\n    ```bash\n    git checkout -b feature/new-feature\n    ```\n4. Make your changes and commit them:\n    ```bash\n    git commit -m \"Add new feature\"\n    ```\n5. Push your changes:\n    ```bash\n    git push origin feature/new-feature\n    ```\n6. Open a Pull Request on GitHub.\n\n- If you encounter a bug or want to see something added/changed, please go ahead and [Open an issue](https://github.com/suman7802/ExpressTemplate/issues/new/choose)\n\n- If you need help with something, feel free to [Start a discussion](https://github.com/suman7802/ExpressTemplate/discussions/new/choose)\n\n## Contact\n\nFor any questions or suggestions, feel free to reach out:\n\n- **Email:** [mansu7802@gmail.com](mailto:mansu7802@gmail.com)\n- **Website:** [suman sharma](https://sumansharma.me)\n- **LinkedIn:** [suman sharma](https://www.linkedin.com/in/suman7802)\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuman7802%2Fexpresstemplate","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuman7802%2Fexpresstemplate","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuman7802%2Fexpresstemplate/lists"}