---
# System prepended metadata

title: Project README (Antoine/PAR)

---

# Project README (Antoine/PAR)

Your project should have the README.md file in their root. This is the most important file in your project and it should have (at least) the following:

In the beginning, start by a summary of your project:

# Project Title

This project is a lorem ipsum dolor sit amet, consectetur adipiscing elit.
Aenean tempus, turpis in aliquet tincidunt,
nibh sem pretium leo, at facilisis odio leo eget nunc.
Next, it should describe the INSTALLation procedure as clear as possible:

list software dependencies
list which commands to execute to have your projects up and running:

## INSTALL

Dependencies:

- node >= 8
- mongod 4.x

```sh
$ npm install
```
It should hold instructions for developers:

## Dev

```sh
$ npm run dev
```
But also instructions for sys-admins:

## Release

You need to be `heroku login` before being able to deploy.

```
$ git push heroku master
```
It is always a good idea to include a table view with root and pages:

## Pages

| Page   | URL     | Description |
| ------ | ------- | ----------- |
| HOME   | /       | homepage    |
| SIGNUP | /signup | signup page |

| ...
And even more, to document the API your project implements:


## API

### `POST /users` -- CREATE

Create a new user.

```json
POST /users
{
  "username": "jdoe",
  "password": "toto123"
}
```

response:

```
201 Created
{
  "_id": "kjnc9n213n2384nb1k24jh12g438",
  "username": "jdoe",
  "password": "1324bhj1{24b2j4.k12h%3b4jh1b234j$"
}
```

if already exists:

```
409 Conflict
{
  "message": "This user already exists"
}
```

or if not secure password:

```
422 Unprocessable Entity
{
  "message": "`password` must have at least 6 chars"
}
```
As you can see, we documented:

request,
response,
BUT ALSO supported 💥 errors.
Whoever has an interest, can find all (or majority) of useful information in the readme.