This project is intended as both an example to be referenced, and a cookbook to kickstart new app development.

Required

1. Git
2. Node.js version >= 10.16.0
3. An IDE (VSCode preferred)

Optional

1. Docker - used to quickly and easily run the backend and database locally. If you prefer, you can directly run the Java jar and MySQL workbench instead.
2. VSCode extension "ESLint" - Quality-of-life extension that will run ESLint against code in real-time

1. Node.js/JavaScript (high-level video and interactive walkthrough)
2. React
3. Redux

1. git clone https://gitlab.nmcapstone.com/nm-capstone-cookbooks/uwm-cs-595-cs-frontend.git
2. cd uwm-cs-595-nm-frontend
3. npm install
4. Start up the backend
   • If you are using Docker, simply follow these steps:
     1. docker login docker.nmcapstone.com
     2. npm run infra:up
   • If you are not using Docker, then please refer to the project docs.

NPM scripts are custom commands that simplify common project tasks, such as:

• Running tests
• Building and starting the application
• Running code quality tools like ESLint

These scripts are defined scripts block of the package.json file, and can be run in a terminal using npm run <script-name>.
If the script requires additional arguments, use the format npm run <script-name> -- <arguments...>.
See below for the included commands and examples

This project includes a base set of commands:

Once you are all set up, with the backend already running, you can start the webapp simply by:

1. Run the command npm run start (Runs the node server)
2. In another terminal npm run start:dev (Builds and watches the client side code)
3. Open a browser
4. Navigate to http://localhost:4000

You can execute all unit and integration tests by running npm run test.
If you only want to run a single test, use the command format npm run test -- path/to/your/file.js.
If you want the tests to automatically re-run when you make changes, use the command format npm run test -- --watchAll.
You can also watch a single test with the command format npm run test -- --watchAll path/to/your/file.js.