Before you install and run this project, you need to have:
Please follow these steps to intall the project:
- Download or clone the repo:
git clone https://github.com/GuyOhm/todo-list-app.git - Navigate to the repo directory in your terminal and type:
npm install - Once all dependencies are installed, run the app with:
npm run start
The app is opening on your favorite browser and is ready for you to use.
To run tests, please navigate to the repo directory in your terminal and type: npm run test.
This will open and run tests in your browser.
To generate documentation, please navigate to the repo directory in your terminal and type: npm run docs.
This will generate and open documentation in your browser for you to navigate through:
- user guide
- technical documentation
- performance audits for our app and one of our concurrent's.
- Vanilla Javascript MVC framework
- jasmine testing framework for writing and running tests
- ESDOC module for generating the documentation
- http-server module to serve our files locally and avoid browser CORS policy