Skills-Auditor-WebApp

A web application using React and Node for auditing skills.

Requirements

• Node
• MySQL server (e.g. XAMPP for local development)

Getting Started

1. Install all node modules (checkout root project directory)

npm install

2. Create a .env file in the backend directory; this requires a TOKEN_SECRET variable, and an optional port variable. For example:

TOKEN_SECRET="secret"
PORT="8080"

3. Start the MySQL database server and initialise with skills_auditor.sql.

4. Ensure backend/config/config.js is setup with correct settings for your MySQL server (defaults are set to XAMPP settings)

5. Run application (production build of frontend served by the API)

npm start

Open web browser and access http://localhost:8900/

NOTE: Test admin user credentials set as follows:

• Username: admin@email.com
• Password: password

Running app for development

For hot reloading React app for changes, run the backend and frontend separately. Open two shells and run the backend:

npm start

Then run the frontend:

npm run start-ui

Open web browser and access http://localhost:3000/

Note: The development frontend will make API calls to the endpoint set by the 'proxy' value in frontend/package.json (default localhost:8900). Change this if you have set the backend to serve on a different port / endpoint.

Note The production build of the application will also be hosted on the same port as your backend; this won't be updated dynamically when the code changes. For development, ignore this route.

API Tests

Tests are kept in the __test__ folder. All test files must follow the file naming convention: *.spec.js

To run the tests:

npm run test:api

The testing.js file is ran before all test files (*.spec.js); it includes the mock of the Sequelize database connection found in models/index.js. We recommend when writing tests that the model itself is mocked to return mock values as well as checking functions are run with the correct values.

UI Tests

Tests are kept in each component / view folder. All test files must follow the file naming convention: *.spec.js

To run the tests:

npm run test:ui

The testing.js file is ran before all test files (*.spec.js); it includes the mocks for the backend service.