|
1 |
| -<p align="center"> |
2 |
| - <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a> |
3 |
| -</p> |
4 | 1 |
|
5 |
| -[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 |
6 |
| -[circleci-url]: https://circleci.com/gh/nestjs/nest |
| 2 | +# Starter Kit |
7 | 3 |
|
8 |
| - <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p> |
9 |
| - <p align="center"> |
10 |
| -<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a> |
11 |
| -<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a> |
12 |
| -<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a> |
13 |
| -<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a> |
14 |
| -<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a> |
15 |
| -<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a> |
16 |
| -<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a> |
17 |
| -<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a> |
18 |
| - <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a> |
19 |
| - <a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a> |
20 |
| - <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a> |
21 |
| -</p> |
22 |
| - <!--[](https://opencollective.com/nest#backer) |
23 |
| - [](https://opencollective.com/nest#sponsor)--> |
| 4 | +This repo is a starter-kit that I use to start a backend project |
24 | 5 |
|
25 |
| -## Description |
| 6 | +## This project build with |
26 | 7 |
|
27 |
| -[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. |
| 8 | +- NestJS |
| 9 | +- TypeORM |
| 10 | +- Redis |
| 11 | +- JWT |
| 12 | + |
| 13 | +### Development |
28 | 14 |
|
29 |
| -## Starter Kit |
| 15 | +- Docker |
| 16 | +- MailHog (Fake SMTP) |
| 17 | +- Adminer |
30 | 18 |
|
31 |
| -### Feature |
| 19 | +## Feature |
32 | 20 |
|
33 | 21 | - [x] Authentication
|
34 | 22 | - [x] JWT Token
|
35 | 23 | - [x] Redis Store
|
36 | 24 | - [x] Multi Language
|
37 |
| - |
38 |
| -## Installation |
39 |
| - |
40 |
| -```bash |
41 |
| -$ yarn install |
42 |
| -``` |
43 |
| - |
44 |
| -## Running the app |
45 |
| - |
46 |
| -```bash |
47 |
| -# development |
48 |
| -$ yarn run start |
49 |
| - |
50 |
| -# watch mode |
51 |
| -$ yarn run start:dev |
52 |
| - |
53 |
| -# production mode |
54 |
| -$ yarn run start:prod |
55 |
| -``` |
56 |
| - |
57 |
| -## Test |
58 |
| - |
59 |
| -```bash |
60 |
| -# unit tests |
61 |
| -$ yarn run test |
62 |
| - |
63 |
| -# e2e tests |
64 |
| -$ yarn run test:e2e |
65 |
| - |
66 |
| -# test coverage |
67 |
| -$ yarn run test:cov |
68 |
| -``` |
69 |
| - |
70 |
| -## Support |
71 |
| - |
72 |
| -Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support). |
73 |
| - |
74 |
| -## Stay in touch |
75 |
| - |
76 |
| -- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) |
77 |
| -- Website - [https://nestjs.com](https://nestjs.com/) |
78 |
| -- Twitter - [@nestframework](https://twitter.com/nestframework) |
79 |
| - |
80 |
| -## License |
81 |
| - |
82 |
| -Nest is [MIT licensed](LICENSE). |
| 25 | +- [x] Object Storage |
0 commit comments