Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 2.2 KB

README.md

File metadata and controls

51 lines (37 loc) · 2.2 KB
Raw

Cadet Frontend

Build Status Coverage Status

Development Setup

  1. Install a stable version of Yarn and NodeJS (use node version 4-9 with nvm).
  2. Run yarn to install dependencies.
  3. Copy the .env.example file as .env and set the variable REACT_APP_IVLE_KEY to contain your IVLE Lapi key.
  4. Run yarn start to start the server at localhost:80. Admin permissions may be required for your OS to serve at port 80.

IVLE LAPI Key

For NUS students, you can access your IVLE LAPI key here.

For Windows Users

In package.json, change line 19: "start-js": "rm -r coverage; BROWSER=none PORT=80 react-scripts-ts start", to: "start-js": "set PORT=80 & react-scripts-ts start",

For Testing of js-slang

  1. For now, use the branch 'update-js-slang' in cadet-frontend
  2. Follow the instructions on js-slang to transpile your own copy
  3. Edit line 41 of package.json in this project to link to the directory of your js-slang and then run yarn:

"js-slang": "file:path/to/js-slang",

Note that this copies your files over, any future changes will not be reflected.

You may try this for a smoother experience.

Application Structure

  1. actions contains action creators, one file per reducer, combined in index.
  2. assets contains static assets.
  3. components contains all react components.
  4. containers contains HOC that inject react components with Redux state.
  5. mocks contains mock data structures for testing
  6. reducers contains all Redux reducers and their state, combined in index.
  7. sagas contains all Redux sagas, combined in index.
  8. slang contains the source interpreter.
  9. styles contains all SCSS styles.
  10. utils contains utility modules.

TypeScript Coding Conventions

We reference this guide.