francescobarbera/c2w-site-front

Cycle2work site frontend

ReactJS front end for Cycle2work project.

Table of Contents

• Folder Structure
• Run the project
• Env Vars

Folder Structure

Apart from the conventions and deps in place for Create React App, this project also use:

• redux
• react-router

And enforce the following structure:

src/
  actions/
  assets/
  components/
  reducers/
    index.js
  views/
    index.js
  config.js

• actions/ is the folder promoted to contains all the redux actions creators;
• assets/ is the folder promoted to contains all the static resources shared accross React components;
• components/ is the folder promoted to contains all the React components that can be shared accross views;
• reducers/index.js should exports the redux store, with all the needed middlewares applied;
• views/index.js is the container for all the views available within the app and the Routes that are associated with those;
• config.js is where all the env vars are readed, eventually defaulted, and exported.

Run the project

Install the dependencies with...

yarn

and then run the project

yarn start

Build the project

To just build the project you can use...

yarn build

Env Vars

REACT_APP_AWS_REPORTS_API