Atelier

ratings-reviews

API service for handling the 'Ratings and Reviews' module of the Atelier shopping app.

Setup

• Clone/pull repo
• npm install
• Create a GitHub authorization token and store it in config.js (make sure it's .gitignored).
• npm start for the server
• npm run build (in a separate terminal) for webpack/react/index.html
• Navigate to http://localhost:3000 in browser

Contributing

• Install Pomander before attempting to push commits:
• curl -s https://raw.githubusercontent.com/reactorcore/pomander/master/bin/install | bash

Documentation

• Documentation such as diagrams for the app and UX styling guidelines are stored in the ./docs directory.
• See the web style guide for the standards we are following for coding and project organization.

Team Members

• Mark Thomas - Engineering Journal

Testing (IP)

• Jest is the framework chosen to test React and probably all JavaScript code in the app.
• Tests are located in the ./tests directory
• npm test to run the tests

Continuous Integration (IP)

Basic test of JavaScript continuous integration uses CircleCI to run the tests, and Coveralls for reporting test coverage.

Circle CI:

Coveralls:

SonarCloud (IP)

Additionally, SonarCloud is used for an overall check of code quality.

Quality:

Maintainability:

Reliability:

Security:

Lines of Code:

Coverage:

Bugs:

Code Smells:

Technical Debt: