From 20f9259ab3bef7f4c5d863f311454c029d355745 Mon Sep 17 00:00:00 2001
From: divlo
Date: Fri, 30 Oct 2020 17:25:25 +0100
Subject: [PATCH] docs: update version and README
---
README.md | 28 +++++++++++++++++++++++-----
api/package-lock.json | 2 +-
api/package.json | 2 +-
website/components/Footer/Footer.jsx | 2 +-
website/package-lock.json | 2 +-
website/package.json | 2 +-
6 files changed, 28 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index c2430b1..3b124d1 100644
--- a/README.md
+++ b/README.md
@@ -5,10 +5,9 @@
-
+
-
@@ -23,7 +22,7 @@ Si vous aimez le projet, vous pouvez aider à **le faire connaître** en utilisa
Les dernières versions publiées : [https://github.com/Divlo/FunctionProject/releases](https://github.com/Divlo/FunctionProject/releases)
-Le projet est disponible sur [function.divlo.fr](https://function.divlo.fr/) (actuellement en version 2.1).
+Le projet est disponible sur [function.divlo.fr](https://function.divlo.fr/) (actuellement en version 2.2).
## 🚀 Open Source
@@ -39,8 +38,9 @@ Si vous voulez avoir les données des catégories et des fonctions, vous pouvez
### Prérequis :
-- NodeJS (et npm) → version récente
-- Base de donnée MySQL → J'utilise Wamp ce qui me permet d'avoir phpmyadmin.
+- [Node.js](https://nodejs.org/) >= 14
+- [npm](https://www.npmjs.com/) >= 6
+- [MySQL](https://www.mysql.com/) >= 5.7
### Commandes (à suivre dans l'ordre) :
@@ -62,6 +62,24 @@ Vous devrez ensuite configurer l'API en créant un fichier `.env` à la racine d
### Lancer l'environnement de développement :
+#### Avec [docker](https://www.docker.com/) :
+
+```sh
+# Setup and run all the services for you
+docker-compose up --build
+```
+
+**Services started :**
+
+- api : `http://localhost:8080`
+- s.divlo.fr : `http://localhost:7000`
+- website : `http://localhost:3000`
+- [phpmyadmin](https://www.phpmyadmin.net/) : `http://localhost:8000`
+- [MailDev](https://maildev.github.io/maildev/) : `http://localhost:1080`
+- [MySQL database](https://www.mysql.com/) (with PORT 3006)
+
+#### Sans docker :
+
Dans deux terminals séparés :
- Lancer le front-end en allant dans `/website`
diff --git a/api/package-lock.json b/api/package-lock.json
index 21b2f25..689aa91 100644
--- a/api/package-lock.json
+++ b/api/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "api",
- "version": "2.1.0",
+ "version": "2.2.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/api/package.json b/api/package.json
index 4ac186f..5352402 100644
--- a/api/package.json
+++ b/api/package.json
@@ -1,6 +1,6 @@
{
"name": "api",
- "version": "2.1.0",
+ "version": "2.2.0",
"description": "Backend REST API for FunctionProject",
"scripts": {
"start": "node app.js",
diff --git a/website/components/Footer/Footer.jsx b/website/components/Footer/Footer.jsx
index 368a2bb..f828136 100644
--- a/website/components/Footer/Footer.jsx
+++ b/website/components/Footer/Footer.jsx
@@ -8,7 +8,7 @@ export default function Footer () {
FunctionProject
- - Version 2.1
+ - Version 2.2
Divlo
{' '}
diff --git a/website/package-lock.json b/website/package-lock.json
index c680180..b06842a 100644
--- a/website/package-lock.json
+++ b/website/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "website",
- "version": "2.1.0",
+ "version": "2.2.0",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
diff --git a/website/package.json b/website/package.json
index 7ea33a0..155db22 100644
--- a/website/package.json
+++ b/website/package.json
@@ -1,6 +1,6 @@
{
"name": "website",
- "version": "2.1.0",
+ "version": "2.2.0",
"description": "Website frontend for FunctionProject",
"main": "server.js",
"scripts": {