Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ixartz/serverless-boilerplate-express-typescript
🚀🎉📚 Boilerplate and Starter for Serverless framework, ExpressJS, TypeScript, Prisma and MongoDB ⚡️ Made with developer experience first: Serverless framework + Live reload + Offline support + ExpressJS + TypeScript + ESLint + Prettier + Husky + Commitlint + Lint-Staged + Jest + Dotenv + esbuild + VSCode
https://github.com/ixartz/serverless-boilerplate-express-typescript
airbnb-eslint aws backend boilerplate eslint express expressjs javascript lambda nodejs offline prettier serverless serverless-framework serverless-http starter starter-template templates typescript vscode
Last synced: 3 days ago
JSON representation
🚀🎉📚 Boilerplate and Starter for Serverless framework, ExpressJS, TypeScript, Prisma and MongoDB ⚡️ Made with developer experience first: Serverless framework + Live reload + Offline support + ExpressJS + TypeScript + ESLint + Prettier + Husky + Commitlint + Lint-Staged + Jest + Dotenv + esbuild + VSCode
- Host: GitHub
- URL: https://github.com/ixartz/serverless-boilerplate-express-typescript
- Owner: ixartz
- License: mit
- Created: 2021-02-24T17:54:29.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T00:42:25.000Z (10 months ago)
- Last Synced: 2025-01-18T01:06:50.508Z (3 days ago)
- Topics: airbnb-eslint, aws, backend, boilerplate, eslint, express, expressjs, javascript, lambda, nodejs, offline, prettier, serverless, serverless-framework, serverless-http, starter, starter-template, templates, typescript, vscode
- Language: TypeScript
- Homepage: https://creativedesignsguru.com
- Size: 5.96 MB
- Stars: 554
- Watchers: 8
- Forks: 81
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Serverless Boilerplate with Serverless Framework 3, ExpressJS, TypeScript, Prisma and MongoDB [](https://twitter.com/ixartz)
🚀 Serverless Boilerplate is starter code for your backend and REST API based on Serverless framework with Express JS, TypeScript, Prisma and MongoDB. ⚡️ Made with Serverless framework, Live reload, Offline support, ExpressJS, TypeScript, ESLint, Prettier, Husky, Lint-Staged, Jest, Commitlint, Dotenv, VSCode.
Clone this project and use it to create your own backend.
### Features
Developer experience first:
- 🔥 [Serverless framework](https://www.serverless.com)
- ⚡️ [ExpressJS](http://expressjs.com)
- ✅ Type checking [TypeScript](https://www.typescriptlang.org) with strict mode
- 📚 ORM with [Prisma](https://www.prisma.io)
- 💖 Database with [MongoDB](https://www.mongodb.com/) with in-memory database for local development
- 📏 Linter with [ESLint](https://eslint.org) with Airbnb configuration
- 💖 Code Formatter with [Prettier](https://prettier.io)
- 🦊 Husky for Git Hooks
- 🚫 Lint-staged for running linters on Git staged files
- 🚓 Lint git commit with Commitlint
- 📓 Write standard compliant commit messages with Commitizen
- 🦺 Unit testing with Jest and Supertest for integration testing
- 👷 Run tests on pull request with GitHub Actions
- 🎁 Automatic changelog generation with Semantic Release
- 💡 Absolute Imports using @ prefix
- 🗂 VSCode configuration: Debug, Settings, Tasks and extension for ESLint, Prettier, TypeScript, Jest
- 📖 Local support with Serverless Offline
- ⚙️ Environment variable with Serverless Dotenv
- 🎉 Fast bundler with esbuild
- ✨ HTTP Api instead of API gateway for cost optimization
- 💨 Live reload
### Philosophy
- Minimal code
- 🚀 Production-ready
### Node.js SaaS Boilerplate - MERN Stack with Serverless
Build your SaaS product faster with [Node.js SaaS Boilerplate](https://modernmern.com).
[](https://modernmern.com)
### Premium Themes
| [Green Nextjs Landing Page Template](https://creativedesignsguru.com/landing-green-modern-nextjs-theme/) | [Purple Saas Nextjs Theme](https://creativedesignsguru.com/landing-purple-modern-react-theme/) |
| --- | --- |
| [](https://creativedesignsguru.com/landing-green-modern-nextjs-theme/) | [](https://creativedesignsguru.com/landing-blue-modern-react-theme/) |
Find more [Nextjs Templates](https://creativedesignsguru.com/category/nextjs/).
### Requirements
- Node.js 16+ and npm
### Getting started
Run the following command on your local environment:
```
git clone --depth=1 https://github.com/ixartz/Serverless-Boilerplate-Express-TypeScript.git my-project-name
cd my-project-name
npm install
```
Then, you can run locally in development mode with live reload:
```
npm run dev
```
The local server is now listening at http://localhost:4000
### Deploy to production
You can deploy to production with the following command:
```
npm run deploy-prod
```
### VSCode information (optional)
If you are VSCode users, you can have a better integration with VSCode by installing the suggested extension in `.vscode/extension.json`. The starter code comes up with Settings for a seamless integration with VSCode. The Debug configuration is also provided for frontend and backend debugging experience.
With the plugins installed on your VSCode, ESLint and Prettier can automatically fix the code and show you the errors. Same goes for testing, you can install VSCode Jest extension to automatically run your tests and it also show the code coverage in context.
Pro tips: if you need a project wide type checking with TypeScript, you can run a build with Cmd + Shift + B on Mac.
### Contributions
Everyone is welcome to contribute to this project. Feel free to open an issue if you have question or found a bug.
### License
Licensed under the MIT License, Copyright © 2022
See [LICENSE](LICENSE) for more information.
---
Made with ♥ by [CreativeDesignsGuru](https://creativedesignsguru.com) [](https://twitter.com/ixartz)
[](https://modernmern.com)