This is the front end web for FreeFrom. It's back end counterpart is located here
- React Front End
- Ruby Back End
- Postgres DB
- Node v10.16.0
- Ruby back end must be running locally on port
3000. If back end is running on a separate server, you can update thepackage.jsonfile, changing theproxyproperty to your back end location.
- Install node_modules
yarn install - Run React application
yarn start(oryarn run start-windowsif on windows)
- We use eslint in conjunction with prettier. Both of these can run automatically with extensions, or else would need to be ran manually
- Please stick with absolute paths for imports
We use Jest for running unit tests. It's packaged with React. Read more about creating React tests on the React website here and more about Jest here
- To run and monitor tests:
yarn run test
- We use redux for state management (
react-redux,redux, andreact-router). Learn more about Redux here: Redux - We use React router for routing/urls. Learn more about Router here: Router Docs
- We use Material UI for handling our overall theme, overriding where needed within the overarching
src/theme.jsfile. Read more about Material UI here: Material UI - We use React Helmet for
<head>specific changes, mostly for SEO. Read more about React Helmet here: React Helmet