Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ileostar/nest-starter
A nestjs serverless startup template deployed on vercel. Nestjs Vercel Serverless起手模版🧸
https://github.com/ileostar/nest-starter
eslint jest nestjs prettier serverless template-project vercel
Last synced: about 1 month ago
JSON representation
A nestjs serverless startup template deployed on vercel. Nestjs Vercel Serverless起手模版🧸
- Host: GitHub
- URL: https://github.com/ileostar/nest-starter
- Owner: ileostar
- License: mit
- Created: 2024-08-14T01:58:20.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-09-23T04:04:53.000Z (about 2 months ago)
- Last Synced: 2024-09-29T16:40:55.098Z (about 2 months ago)
- Topics: eslint, jest, nestjs, prettier, serverless, template-project, vercel
- Language: TypeScript
- Homepage: https://nest-starter.leostar.top/swagger
- Size: 124 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
A nestjs serverless startup template deployed on vercel.🧸
English | 简体中文
## ✨Try it now!
### GitHub Template
[Create a repo from this template on GitHub👈](https://github.com/ileostar/nest-starter/generate).
### Deploy on Vercel
One-click deployment to Vercel
[](https://vercel.com/import/project?template=https://github.com/ileostar/nest-starter)
## 🧾Checklist
When you use this template, try follow the checklist to update your info properly
- [ ] Change the author name in LICENSE
- [ ] Change the infos in package.json
- [ ] Change the config in docker-compose.yml
- [ ] Change `.env.example`/`.env.prod.example` to `.env`/`.env.prod`
- [ ] Remove the .github folder which contains the funding info
- [ ] Clean up the READMEs
nd, enjoy :)
## 🍚Usage
### Installation
```bash
$ pnpm install
```
### Running the app
```bash
# development
$ pnpm run start
# watch mode
$ pnpm run start:dev
# production mode
$ pnpm run start:prod
```
### Test
```bash
# unit tests
$ pnpm run test
# e2e tests
$ pnpm run test:e2e
# test coverage
$ pnpm run test:cov
```
### Build
To build the Server, run
```bash
$ pnpm build
```
And you will see the generated file in dist that ready to be served.
### Docker Production Build & Start
```bash
$ docker-compose up --build
```
## Support
🎉 Thank you so much for checking out our project! If you found this project helpful or you think it's cool, you can send us a sign of support at 🌟star🌟. This will help our project to get more attention and development, but also a kind of encouragement and affirmation of our efforts.
🚀 Of course, if you have any suggestions, feedback or contributions that would like to participate in the project, we are very welcome! You can interact with us by submitting an Issue or Pull Request.
💖 Thank you for your support!