Staging
Production
This repository contains source code for the new RV management UI, coded during University course 'Software development project, Spring 2018'
Production URL for the application is https://rv-management.herokuapp.com, while staging can be found at https://rv-management-dev.herokuapp.com.
- Clone the repo
- Install Yarn (if not installed before)
yarn installto install project dependencies- Create a .env file and define in it the variable
REACT_APP_BACKEND_URLthat points to backend server's address yarn startfor starting the app,yarn storybookwhen developing modules oryarn styleguidewhen creating documentation.
Run yarn build to build the project. This will create a production-optimized build to build folder.
For UI component documentation, please click this link
This is a JavaScript application powered by React. React Redux is used to handle the app's state, with the help of redux-thunk for asynchronous actions. UI components do not use external styling rules, so every UI component you see in this project is styled from scratch.
Testing of UI components is made with Enzyme & Jest, and Redux store is mocked with redux-mock-store.
When developing UI components, use React Storybook. It allows the development of single UI components instead of adding a new component to the application and develop it 'live'.
Write tests as new code is written to make sure that each UI component gets tested throughfully. New UI components shall also be documented on the fly, with the help of React Styleguide.
Code must pass linters in order to be commited. When a commit is made, ESLint and Stylelint will make sure that styling guidelines are followed. The commit will not go through, if even one error is detected.
Use these scripts to help yourself in development.
yarn lint-jslints JavaScript files.yarn fix-jslints and fixes potential code issues in JavaScript files.yarn lint-csslints SCSS files.yarn fix-csslints and fixes potential code issues in SCSS files.
If you want to use npm, replace yarn command with npm run-script.
New features or fixes must have a branch. Pushing directly to develop or master is not allowed (though certain emergency cituations do not follow this rule) See this link on how to use Git Flow.
When code is pushed to GitHub and a pull request is made to either develop or master branch, Travis CI will run tests for the project and deploy it to Heroku, if all test have passed.
This project is licensed with GNU GPL v2 license.
