Skip to content

Latest commit

 

History

History
41 lines (34 loc) · 3.06 KB

README.md

File metadata and controls

41 lines (34 loc) · 3.06 KB
Raw

stackup2-barefoot-frontend

Build Status Test Coverage Codacy Badge

To run it locally

A. Pre-requisites:

  • To be able to test this project locally, you need to have the following tools on your local machine:

B. Steps

  1. Clone this repo by running git clone https://github.com/Stackup-Rwanda/stackup2-barefoot-frontend.git
  2. Install all needed dependencies by running npm install or yarn
  3. Create a .env file
  4. Copy all of the fields from .env.example, paste them in .env file and provide values for them
  5. Start Local server by running npm start or yarn start to run it in production mode.
  6. npm run dev or yarn run dev to run it in development mode.
  7. Go to http://localhost:{{PORT}}/ =>{{PORT}} : is the port number that you precise in your .env file

C. Tools used

  1. Webpack 4 for bundling
  2. Express for serving the frontend
  3. GitHub and Git for Version control
  4. TravisCI for continuous integration
  5. JestJS for testing
  6. Enzyme for DOM testing

D. Dependencies

  1. node-sass
  2. sass
  3. sass-loader
  4. Storybook
  5. Enzyme
  6. Material-UI

E. Deployments

  • This application is deployed on heroku, we have two different versions, which are different by the app status, in staging mode or ready for production.

  • When the app is in staging mode is available on this link https://stackup-barefoot.herokuapp.com/ => This deployment happens automatically, whenever there is a new merging to develop branch

  • When the app is ready for production is available on this link https://immense-chamber-27847.herokuapp.com/

  • Whenever a new PR is opened, there is a new review app which is created and accessible in the browser which helps to access visualize your PR in the browser to check if it working as you wanted it to work.