Merge c62ef21 into dcf22ad

CONTRIBUTING.md

@@ -77,15 +77,15 @@ In order to accept your pull request, we need you to submit a CLA. You only need
 
 ### Development Workflow
 
-After cloning React, run `yarn install` to fetch its dependencies.
+After cloning Wipkanban, run `yarn install` to fetch its dependencies.
 Then, you can run several commands:
 
-* `yarn run lint` checks the code style.
+* `yarn lint` checks the code style.
 * `yarn test` runs the complete test suite backend api and frontend.
 * `yarn run prettier` to format your code.
 * `yarn run analyze` to generate [webpack bundle analyze](https://github.com/webpack-contrib/webpack-bundle-analyzer).
 * `yarn run apidoc` to generate api documentation. To access go to `apidoc/index.html`.
-* `yarn run check` to verify if your dependences are updated.
+* `yarn outdated` to verify if your dependences are updated.
 * `yarn build` creates a `build` folder with all the code to production.
 
 We recommend running `yarn test` to make sure you don't introduce any regressions as you work on your change..

README.md

@@ -11,6 +11,7 @@
 Be the best tool for lean management based on kanban. And one more thing, be Open Source!
 
 ## How to use
+WipKanban is bult with Reactjs, Express and MongoDb as database
 
 ### Download source code:
 
@@ -22,28 +23,23 @@ git clone https://github.com/wipkanban/wipkanban
 ```bash
 cd wipkanban
 
-yarn install
+yarn
 ```
 
+### Setting up the .env file:
+Rename .env-template file with your data
+
 ### Run application
 ```bash
 
-yarn run server
+yarn server
 
 ```
 To access enter the address htts://<YOUR_IP_ADDRESS>:3000 in the browser
 
 ### Run tests
 The tests are divided between client and server
 
-```bash
-#run all tests
-yarn run test
-
-#run tests while developtment
-yarn run test:dev
-```
-
 ## [How to Contribute](https://github.com/wipkanban/wipkanban/blob/master/CONTRIBUTING.md)
 The main purpose of this repository is to continue to evolve WipKanban, making it the best possible experience in using Kanban. Development of WipKanban happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements.