Update README.md

README.md

@@ -17,21 +17,28 @@ https://react-user-onboarding.netlify.app/
 ![Consultant](client/src/images/user-onboarding.png)
 
 ## Table of Contents
-* [Demo](#demo)
-* [General info](#general-info)
-* [Features](#features)
-* [Requirements](#requirements)
-* [Setup](#setup)
-* [Versions](#versions)
+- [User Onboarding](#user-onboarding)
+    - [Stable Version v0.1.0](#stable-version-v010)
+  - [Demo](#demo)
+  - [Table of Contents](#table-of-contents)
+  - [General info](#general-info)
+  - [Features](#features)
+    - [Frontend](#frontend)
+    - [Backend](#backend)
+  - [Requirements](#requirements)
+  - [Setup](#setup)
+  - [Versions](#versions)
 
 ## General info
 
 The purpose of this project is to learn React library, what is a component and how to handle it, the usage of the context to share the step and the user between the components. Each component was tested with Jest and React testing library.
 
-The user has to compile the form in three steps, in each step there is the validation of the inputs value. At the end when the "Finish" button is clicked the user object is sent to the backend, in this case there is a fake call to an API.
+The user has to compile the form in three steps, in each step there is the validation of the inputs value. At the end when the "Finish" button is clicked the user object is sent to the backend that give back a response.
 
 ## Features
 
+### Frontend
+
 * Languages and structure used to develop this project:
   * *JavaScript*
   * *SASS / PostCSS*
@@ -48,30 +55,22 @@ The user has to compile the form in three steps, in each step there is the valid
 * Latest [Babel 7](https://github.com/babel/babel) (`@babel/core`) - JavaScript compiler - _Use next generation JavaScript, today._
 * Configured and ready to use **Webpack Dev Server** plugin for faster local development - [`webpack-dev-server`](https://webpack.js.org/configuration/dev-server/)
 
+### Backend
+
+* Latest [Express](http://expressjs.com/) - Web framework for Node.js
+* [PostgreSQL](https://www.postgresql.org/) - A realational database
+* [Knex.js](https://knexjs.org/) - SQL query builder
+
 ## Requirements
 
 * `node` : `^10 || ^12 || >=14`
 * `npm`
 
 ## Setup
 
+[Frontend README](https://github.com/AngyDev/react-user-onboarding/tree/main/client/README.md)
 
-``` bash
-# install dependencies
-npm install
-
-# build for development
-npm run build
-
-# run the project
-npm run start
-
-# run the test
-npm run test
-
-# run the test coverage
-npm run test-coverage 
-```
+[Backend README](https://github.com/AngyDev/react-user-onboarding/tree/main/server/README.md)
 
 ## Versions
 

client/README.md

@@ -0,0 +1,18 @@
+## Frontend Setup
+
+``` bash
+# install dependencies
+npm install
+
+# build for development
+npm run build
+
+# run the project
+npm run start
+
+# run the test
+npm run test
+
+# run the test coverage
+npm run test-coverage 
+```

server/README.md

@@ -0,0 +1,24 @@
+# Backend
+
+## DB
+
+PostgreSQL is the DB used in this project, to try the backend functionalities you have to create a local DB with the connection used in the `utils/knexfile.js` or if you want you can change that. 
+
+## Setup
+
+``` bash
+# install dependencies
+npm install
+
+# run the project
+npm run start
+
+# run the migrations
+npm run knex migrate:latest
+```
+
+## Calls the API
+
+If you want to try the API call you can run on the browser the following command:
+
+`http://localhost:3000/users`