docs: Write README (#35)

* docs: Create README structure

* docs: Replace html links by markdown links

* test: Try a link syntax

* fix: Use HTML links

* revert: Use HTML links

* docs: Add Quality Assurance in README

* fix: file

* Revert "fix: file"

This reverts commit d6992d9.

* docs: Add environment file step

* test: Adding build status badge

* feat: Add build status badge

* feat: Add localhost links

* feat: Add PRs badge

* feat: Add last commit badge

* fix: Remove badges not work

* feat: Add icon in description

Author: vbetsch

README.md

@@ -1,36 +1,176 @@
-This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
+[//]: # (<img src="LOGO_PATH" alt="LOGO_NAME" style="width: 500px;">)
 
-## Getting Started
+# Locklite
 
-First, run the development server:
+🔐 Intranet password manager for
+businesses [![Build Status](https://github.com/vbetsch/lockLite/actions/workflows/ci.yml/badge.svg)](https://github.com/vbetsch/lockLite/actions)
 
-```bash
+![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
+![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
+![Next JS](https://img.shields.io/badge/Next-black?style=for-the-badge&logo=next.js&logoColor=white)
+![Vercel](https://img.shields.io/badge/vercel-%23000000.svg?style=for-the-badge&logo=vercel&logoColor=white)
+![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white)
+![Prisma](https://img.shields.io/badge/Prisma-3982CE?style=for-the-badge&logo=Prisma&logoColor=white)
+![Swagger](https://img.shields.io/badge/-Swagger-%23Clojure?style=for-the-badge&logo=swagger&logoColor=white)
+![Jest](https://img.shields.io/badge/-jest-%23C21325?style=for-the-badge&logo=jest&logoColor=white)
+![MUI](https://img.shields.io/badge/MUI-%230081CB.svg?style=for-the-badge&logo=mui&logoColor=white)
+![GitHub Actions](https://img.shields.io/badge/github%20actions-%232671E5.svg?style=for-the-badge&logo=githubactions&logoColor=white)
+![ESLint](https://img.shields.io/badge/ESLint-4B3263?style=for-the-badge&logo=eslint&logoColor=white)
+![Prettier](https://img.shields.io/badge/prettier-%23F7B93E.svg?style=for-the-badge&logo=prettier&logoColor=black)
+
+[//]: # (## Asserts)
+
+[//]: # (- [ASSERT_NAME]&#40;ASSERT_PATH&#41;)
+
+### Dependencies
+
+You have to install these softwares before starting :
+
+- [**Docker** Engine](https://docs.docker.com/engine/install/)
+- [**Docker** Compose](https://docs.docker.com/compose/install/)
+- [**NodeJS** (v.22.17.1)](https://nodejs.org/en/blog/release/v22.17.1)
+
+### Table of contents
+
+Choose your operating system :
+
+- [Windows](#windows)
+- [MacOS](#macos)
+- [Linux](#linux)
+
+<h2 id="windows">Windows</h2>
+
+We recommend using a WSL for this project. If so, please follow the [Linux](#linux) procedure.
+
+### Installation
+
+1. Create a `.env` file by copying the example file `.env.example` file. Replace the default values with your own.
+
+2. You need to install NodeJS packages
+
+```shell
+npm install
+```
+
+### Getting Started
+
+1. Start docker services with the following command
+
+```shell
+docker-compose up -d
+```
+
+2. Launch the application in development mode
+
+```shell
+npm run dev
+```
+
+3. Well done, the application is running!
+
+- UI : http://localhost:3000/ui (homepage)
+- API : http://localhost:3000/api/docs (Swagger documentation)
+
+### Quality Assurance
+
+- Run unit tests
+
+```shell
+npm test
+```
+
+- Run unit tests with coverage
+
+```shell
+npm run test:cov
+```
+
+<h2 id="macos">MacOS</h2>
+
+### Installation
+
+1. Create a `.env` file by copying the example file `.env.example` file. Replace the default values with your own.
+
+2. You need to install NodeJS packages
+
+```shell
+npm install
+```
+
+### Getting Started
+
+1. Start docker services with the following command
+
+```shell
+docker-compose up -d
+```
+
+2. Launch the application in development mode
+
+```shell
 npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+3. Well done, the application is running!
+
+- UI : http://localhost:3000/ui (homepage)
+- API : http://localhost:3000/api/docs (Swagger documentation)
+
+### Quality Assurance
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+- Run unit tests
 
-This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
+```shell
+npm test
+```
+
+- Run unit tests with coverage
 
-## Learn More
+```shell
+npm run test:cov
+```
 
-To learn more about Next.js, take a look at the following resources:
+<h2 id="linux">Linux</h2>
 
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+### Installation
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
+1. Create a `.env` file by copying the example file `.env.example` file. Replace the default values with your own.
 
-## Deploy on Vercel
+2. You need to install NodeJS packages
 
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+```shell
+npm install
+```
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
+### Getting Started
+
+1. Start docker services with the following command
+
+```shell
+docker-compose up -d
+```
+
+2. Launch the application in development mode
+
+```shell
+npm run dev
+```
+
+3. Well done, the application is running!
+
+- UI : http://localhost:3000/ui (homepage)
+- API : http://localhost:3000/api/docs (Swagger documentation)
+
+### Quality Assurance
+
+- Run unit tests
+
+```shell
+npm test
+```
+
+- Run unit tests with coverage
+
+```shell
+npm run test:cov
+```