Skip to content

cromaLab/legiontools-react

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

39 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LegionTools React/Redux

This project was bootstrapped with Create React App.

Setting Up Dev Environment

yarn

Run yarn to install dependencies

yarn start

Run yarn start to spinup the app on http://localhost:3000.

Adding dependencies

If you need to install npm libraries to the app, please use yarn add [packagename].

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

App Structure

This is what the src folder looks like, with some info on each item:

src
├── App.css - "use for adding global styles"
├── App.js - "the 'main' component for the entire LegionTools app"
├── components - "all of the React components used in LegionTools"
   ├── auth - "components used for providing credentials"
      └── loginModal.jsx - "the modal for providing the AWS keys"
   ├── experimentpane - "components used for the left pane of LegionTools"
      ├── loadPanel.jsx - "this is the tab for the 'Load' panel"
      ├── pane.jsx - "this is the 'main' component for the left pane."
      └── recruiting - "components used for the 'Recruiting' panel"
          ├── directTab.jsx - "the tab for configuring HITs in Direct mode"
          ├── recruitingPanel.jsx - "the 'main' component of the panel"
          └── retainerTab.jsx - "the tab for configuring Retainer mode"
|   ├── hide_view.jsx - "a general purpose class used to make a component inaccessible."
   ├── infoModal.jsx - "a general purpose modal class used to inform the user."
   └── livepane - "components used for the right pane of LegionTools"
       └── pane.jsx - "the 'main' component for the right pane"
├── index.css - "don't edit this; generated by CRA"
├── index.js - "don't edit this; generated by CRA"
├── redux - "all redux related code"
   ├── actions
      ├── actionTypes.js - "describes enums for the various Redux actions that we'll define"
      ├── actions.js - "the 'main' JS file for compiling all the Redux actions together"
      ├── experimentPaneActions.js - "Redux actions related to modifications made in the left pane"
      └── loginActions.js - "Redux actions related to logging in"
   └── reducers
       ├── experimentPaneReducers.js
       ├── loginReducers.js
       └── reducers.js - "the 'main' JS file for compiling all the Redux reducers into one"
├── serviceWorker.js - "don't edit this; generated by CRA"
└── store.js - "the file describing the initialization of the Redux store"

Learn More about CRA, React, React Bootstrap, and Redux

The following links to various docs will surely be useful.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •