README.md 3.85 KB
Newer Older
Hugo SUBTIL's avatar
Hugo SUBTIL committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
<p align="center">
  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo_text.svg" width="320" alt="Nest Logo" /></a>
</p>

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
  
  <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>
    <p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<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>
<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>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
    <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>
  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
</p>
  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->

## Description

27
L'appplication est basée sur le framework [Nest](https://github.com/nestjs/nest). Celle-ci utilise une BDD mongodb.
Hugo SUBTIL's avatar
Hugo SUBTIL committed
28
29
30

## Installation

31
32
33
34
35
36
37
38
39
40
41
### Prérequis

Windows: avoir Docker Desktop installé
Linux: avoir docker et docker-compose installé

Créer un ficher .env sur le modèle du ficher `template.env` et remplir les différentes variables.

### Application

Installation des dépendences applicatives:

Hugo SUBTIL's avatar
Hugo SUBTIL committed
42
43
44
45
46
47
```bash
$ npm install
```

## Running the app

48
49
50
51
52
53
54
55
56
57
### Base de donnée


```bash
$ docker-compose up -d database-ram
$ docker-compose up -d mongo-express
```

### Application

Hugo SUBTIL's avatar
Hugo SUBTIL committed
58
59
60
61
62
63
64
65
66
67
68
```bash
# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod
```

69
70
71
72
73
74
75
76
77
78
### Infos

```bash
# Lien vers le swagger
$ http://localhost:3000/api

# Lien vers le mongo-express
$ http://localhost:8081
```

Hugo SUBTIL's avatar
Hugo SUBTIL committed
79
80
81
82
83
84
85
## Documentation 
A documentation is generated with compodoc in addition of the existing documentation on the wiki.
```sh
npm run doc:serve
```
You can now visualize it at : `localhost:8080`

Hugo SUBTIL's avatar
Hugo SUBTIL committed
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
## Test

```bash
# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov
```

## Support

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).

## License

105
Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).