You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-9Lines changed: 11 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,29 +10,31 @@ Besides the registration the project has a simple login/logout feature made usin
10
10
> - This application uses Sequelize ORM to manage relational database and maintain it's data.
11
11
> - The [Passport](https://www.npmjs.com/package/passport) is basically a Express-compatible authentication middleware for Node.js.
12
12
13
-
I prefer not to use Flow to type data in this project, we'll use prop-types feature to type properties in React components and also say if it's necessarily required or not.
14
-
15
-
If you have some suggestion, let me know about it!
13
+
I didn't think it was interesting to use Flow for data typing, instead I chose to use only prop-types to cover the type and obligation for React Components, when it's necessary.
16
14
17
15
#### Server-Side
18
16
The NodeJS Express application, located in the ```/server/``` folder.
19
17
20
18
Inside it's scope use ```npm install``` to install all dependencies and ```npm start``` to run the server application after that.
21
19
22
-
>Be sure database is working before starting the server.
23
-
>Database configurations for each environment are inside```/server/config/database.json```.
20
+
>-Be sure that the database is working before starting the server.
21
+
>- All the database connections you need (for each environment) are in```/server/config/database.json```.
24
22
25
23
#### Client-Side
26
-
Located in the ```/client/``` folder the client-side React application was built within the functional preconfigured project (with Babel, Webpack, and more..) provided by the official Facebook [create-react-app](https://www.npmjs.com/package/create-react-app) npm package that simply says in it's GitHub "Create React apps with no build configuration".
24
+
In the ```/client/``` folder we have the client-side React application.
25
+
26
+
This client was built using the official Facebook [create-react-app](https://www.npmjs.com/package/create-react-app) npm package. This package basically create a working React application, configured with minimal dependency and granting imediate work with no configuration for features like Babel, Webpack, and another stuff (because it's already done).
27
27
28
28
To install npm dependencies use ```npm install``` and finally ```npm start``` to run the React application.
29
29
30
30
#### TDD + BDD
31
-
To verify if API we have done are working succesfully, we have writen some tests in Mocha + Chai, disposed in ```/server/test/```.
31
+
We have some tests too to be sure that our client and server-side API are working succesfully.
32
+
33
+
There some tests I wrote in Mocha + Chai, disposed in ```/server/test/```.
32
34
33
-
We are using Mocha for the tests and Chai to the asserts (TDD) and the behaviour tests (BDD) to improve the test accuracy against the way we use the API and also the way we should take care about errors.
35
+
Mocha is used to build the tests and Chai to configure the asserts (TDD) and the behaviours (BDD) to improve the test accuracy against the way we can use the API and also the way we should take care about errors. This way we know it's OK for every case.
34
36
35
-
You can run the tests just entering the test folder and type in terminal: ```npm run test```.
37
+
You can run the tests just entering the test folder and type in terminal: ```npm run test``` - It's configured to run and compile with Babel for ES6 in then server "package.json".
0 commit comments