Skip to content

Commit b012c70

Browse files
committed
Update README.md
1 parent 92aae9f commit b012c70

File tree

3 files changed

+64
-23
lines changed

3 files changed

+64
-23
lines changed

README.md

Lines changed: 22 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,28 @@ https://react-user-onboarding.netlify.app/
1717
![Consultant](client/src/images/user-onboarding.png)
1818

1919
## Table of Contents
20-
* [Demo](#demo)
21-
* [General info](#general-info)
22-
* [Features](#features)
23-
* [Requirements](#requirements)
24-
* [Setup](#setup)
25-
* [Versions](#versions)
20+
- [User Onboarding](#user-onboarding)
21+
- [Stable Version v0.1.0](#stable-version-v010)
22+
- [Demo](#demo)
23+
- [Table of Contents](#table-of-contents)
24+
- [General info](#general-info)
25+
- [Features](#features)
26+
- [Frontend](#frontend)
27+
- [Backend](#backend)
28+
- [Requirements](#requirements)
29+
- [Setup](#setup)
30+
- [Versions](#versions)
2631

2732
## General info
2833

2934
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.
3035

31-
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.
36+
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.
3237

3338
## Features
3439

40+
### Frontend
41+
3542
* Languages and structure used to develop this project:
3643
* *JavaScript*
3744
* *SASS / PostCSS*
@@ -48,30 +55,22 @@ The user has to compile the form in three steps, in each step there is the valid
4855
* Latest [Babel 7](https://github.com/babel/babel) (`@babel/core`) - JavaScript compiler - _Use next generation JavaScript, today._
4956
* Configured and ready to use **Webpack Dev Server** plugin for faster local development - [`webpack-dev-server`](https://webpack.js.org/configuration/dev-server/)
5057

58+
### Backend
59+
60+
* Latest [Express](http://expressjs.com/) - Web framework for Node.js
61+
* [PostgreSQL](https://www.postgresql.org/) - A realational database
62+
* [Knex.js](https://knexjs.org/) - SQL query builder
63+
5164
## Requirements
5265

5366
* `node` : `^10 || ^12 || >=14`
5467
* `npm`
5568

5669
## Setup
5770

71+
[Frontend README](https://github.com/AngyDev/react-user-onboarding/tree/main/client/README.md)
5872

59-
``` bash
60-
# install dependencies
61-
npm install
62-
63-
# build for development
64-
npm run build
65-
66-
# run the project
67-
npm run start
68-
69-
# run the test
70-
npm run test
71-
72-
# run the test coverage
73-
npm run test-coverage
74-
```
73+
[Backend README](https://github.com/AngyDev/react-user-onboarding/tree/main/server/README.md)
7574

7675
## Versions
7776

client/README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
## Frontend Setup
2+
3+
``` bash
4+
# install dependencies
5+
npm install
6+
7+
# build for development
8+
npm run build
9+
10+
# run the project
11+
npm run start
12+
13+
# run the test
14+
npm run test
15+
16+
# run the test coverage
17+
npm run test-coverage
18+
```

server/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Backend
2+
3+
## DB
4+
5+
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.
6+
7+
## Setup
8+
9+
``` bash
10+
# install dependencies
11+
npm install
12+
13+
# run the project
14+
npm run start
15+
16+
# run the migrations
17+
npm run knex migrate:latest
18+
```
19+
20+
## Calls the API
21+
22+
If you want to try the API call you can run on the browser the following command:
23+
24+
`http://localhost:3000/users`

0 commit comments

Comments
 (0)