rose

“Currency Exchange” dashboard using React

Local development

Install development dependencies

Requires that you first install Yarn for managing the packages, and Node.js for running the software itself. You might also want to read a bit more details on about how to install Node.js with nvm to Linux or macOS.

After you have installed those, run the following command on your command line terminal (in the directory of this project's files) to automatically download and install the required npm packages for you. More detailed notes about how to use Yarn can be read from the their documentation.

yarn install

Start application

After you have installed the dependencies with Yarn, you can start the application locally in a development mode.

yarn start

Run tests

For starting test runner, use:

yarn run test

Code coverage

Report about the code coverage of the test suite can be generated with:

yarn run coverage

Style guide

Develop & debug individual React components with the React Styleguidist. It is an isolated React component development environment, with a living style guide.

Start the local styleguide with

yarn run styleguide

Building static version of the style guide

If you want to make a static version of the style guide for people to look at, run the following command to generate it for you.

yarn run styleguide:build

Building a production version of the application

After you have developed and tested things locally, you can use the following command to build a production version of the application.

yarn run build

Deploying the application to a production environment

TODO: More detailed instructions on how to deploy the application to an real world environment should be written.

• Static site hosting for the React-based SPA (Single Page Application)
• Static site hosting for the style guide

Automated testing with 3rd party services

TODO: Write details on how this application will be tested with 3rd party automated services for the code quality analysis and continuous integration (CI).

Running tests locally

You can simulate CI server's build environment with:

CI=true yarn run build

You can simulate CI server's test environment with:

CI=true yarn run test

Treating warnings as errors because process.env.CI = true. Most CI servers set it automatically.

You could have a Git pre-commit hook that would check if there are any warnings (before allowing you to commit code to the Git repository). That would potentially reduce the potential issues in the future, while making sure that the code does not fall too much apart.

It is recommended to run the tests locally before you commit to the Git repository.

Running tests with CI server

• .travis.yml file contains the settings for the Travis CI service.
  • Building a JavaScript and Node.js project page has more instructions for running Node.js projects.
    • Remember that this project uses yarn instead of npm for managing dependencies. You should only use one of them, as there is an issue ("npm install" deletes everything from a Yarn-produced tree) related to overlapping package managers.

Git commit guidelines

This project's Git commit messages should follow the naming conventions of the AngularJS project.