Skip to content

Latest commit

 

History

History
39 lines (30 loc) · 2.07 KB

README.md

File metadata and controls

39 lines (30 loc) · 2.07 KB
Raw

FreeFrom

Front End

This is the front end web for FreeFrom. It's back end counterpart is located here

Tech

  • React Front End
  • Ruby Back End
  • Postgres DB

Requirements

  • 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 the package.json file, changing the proxy property to your back end location.

Set up

  1. Install node_modules yarn install
  2. Run React application yarn start (or yarn run start-windows if on windows)

Code Style

  1. We use eslint in conjunction with prettier. Both of these can run automatically with extensions, or else would need to be ran manually
  2. Please stick with absolute paths for imports

Running Tests

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

  1. To run and monitor tests: yarn run test

Important Tools

  • We use redux for state management (react-redux, redux, and react-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.js file. 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

Contributors

Contributors