|
1 |
| -# E-Commerce (README deprecated) |
| 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> |
2 | 4 |
|
3 |
| -E-Commerce project. School work. (Under development) |
| 5 | +[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456 |
| 6 | +[circleci-url]: https://circleci.com/gh/nestjs/nest |
4 | 7 |
|
5 |
| -## Config |
| 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)--> |
6 | 24 |
|
7 |
| -Create your `.env` following `.env.example` and don't forget |
8 |
| -to modify the `const HOST` in `src/public/js/config.mjs` |
| 25 | +## Description |
9 | 26 |
|
10 |
| -## Development |
| 27 | +[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. |
11 | 28 |
|
12 |
| -Modify the `HOST=` in `.env` to your location and the `NODE_ENV=` to |
13 |
| -`development` and modify the `const HOST` in `src/public/js/config.mjs` as well. |
| 29 | +## Installation |
14 | 30 |
|
15 | 31 | ```bash
|
16 |
| -npm ci |
17 |
| -npm run build |
| 32 | +$ npm install |
18 | 33 | ```
|
19 | 34 |
|
20 |
| -## Up |
| 35 | +## Running the app |
21 | 36 |
|
22 | 37 | ```bash
|
23 |
| -docker-compose up |
| 38 | +# development |
| 39 | +$ npm run start |
| 40 | + |
| 41 | +# watch mode |
| 42 | +$ npm run start:dev |
| 43 | + |
| 44 | +# production mode |
| 45 | +$ npm run start:prod |
| 46 | +``` |
| 47 | + |
| 48 | +## Test |
| 49 | + |
| 50 | +```bash |
| 51 | +# unit tests |
| 52 | +$ npm run test |
| 53 | + |
| 54 | +# e2e tests |
| 55 | +$ npm run test:e2e |
| 56 | + |
| 57 | +# test coverage |
| 58 | +$ npm run test:cov |
24 | 59 | ```
|
25 | 60 |
|
26 |
| -## Dependencies |
| 61 | +## Support |
27 | 62 |
|
28 |
| -- `bcrypt` |
29 |
| -- `cookie-parser` |
30 |
| -- `cors` |
31 |
| -- `dotenv` |
32 |
| -- `compression` |
33 |
| -- `express` |
34 |
| -- `jsonwebtoken` |
35 |
| -- `node-cron` |
36 |
| -- `nodemailer` |
37 |
| -- `sequelize` |
38 |
| -- `sqlite3` |
39 |
| -- `xss` |
40 |
| -- `zod` |
| 63 | +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). |
41 | 64 |
|
42 |
| -## Database |
| 65 | +## Stay in touch |
43 | 66 |
|
44 |
| -Currently the project uses SQLite `sqlite3` and `sequelize` as ORM. |
45 |
| -The database location is at `.data/database.db` |
| 67 | +- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com) |
| 68 | +- Website - [https://nestjs.com](https://nestjs.com/) |
| 69 | +- Twitter - [@nestframework](https://twitter.com/nestframework) |
46 | 70 |
|
47 |
| -## Preview |
| 71 | +## License |
48 | 72 |
|
49 |
| -https://developstore.up.railway.app |
| 73 | +Nest is [MIT licensed](LICENSE). |
0 commit comments