ByronFiler / brimark-frontend

brimark-frontend

1. Download nodeJS v14.15.3

2. Download the parcel-bundler:

npm install -g parcel-bundler@1.12.4

3. Install Typescript:

npm install -g typescript@4.1.5

4. To install all the packages from the package.json:

npm install

5. To fix any severity vulnerabilities:

npm audit fix

To run the project locally use the command.

npm run local

To run the project locally but with tests first:

npm run local-with-tests

To run the tests:

npm test

If you want to build the project:

npm run build

To build the documentation:

npm run ts-docs

To build the test coverage document:

npm run ts-coverage

API(s) Used:

• Mocha Javascript Testing Library
• Chai BDD / TDD assertion library
• TypeDoc Documentation generator for TypeScript projects.
• ParcelJS Web application bundler
• Type-Coverage A CLI tool to check type coverage for typescript code
• TypeScript-Coverage-Report command line tool for generating TypeScript coverage reports

CSS Framework(s):

• Materialize-CSS A modern responsive front-end framework based on Material Design