Skip to content
This repository has been archived by the owner on Apr 28, 2021. It is now read-only.

Latest commit

 

History

History
76 lines (63 loc) · 2.76 KB

README.md

File metadata and controls

76 lines (63 loc) · 2.76 KB
Raw

Lutra Redux

This implements the front-end using React for our view layer and Redux for state management. Currently, only the groups front-end is being implented using this.

Setup

You need NodeJS 6.x or higher and the latest version of Yarn.

To avoid using sudo with Yarn, configure Yarn to install globals in a subdirectory that doesn't require sudo (like ~/.yarn):

yarn config set prefix ~/.yarn
mkdir ~/.yarn

Then add ~/.yarn to your path, e.g. in your .bashrc:

export PATH=$PATH:~/.yarn/bin

Finally, call make setup.

Development

Start a dev server with make watch. The site will be served on http://localhost:5000 by default.

Testing

Call make test after doing make setup. Tests should be included alongside the modules being tested using the form module.test.ts (or tsx).

Types

This repo uses Typescript 2. To bring in new types, simply install the NPM package with the requisite type (sometimes NPM packages are bundled with the correct types already, but if not, it's usually something like @types/package).

Organization

These are determined via our Webpack entry points (current just groups.js).

  • assets - Static assets
  • config - Config files loaded for dev or prod environments. Available in TS with import { varYouNeed } from 'config';
  • less - LESS / CSS files. By convention, files starting with an _ are partials meant to be imported into other LESS files. Because we use Webpack in this repo, files must actually be required from an entry point.
  • test-helpers - Contains anything needed to help make test work.
  • ts - Typescript
    • components - Reusable React components
    • groups.js - Groups-specific code + main loop
    • lib - Generic Typescript libraries and helpers
    • states - Redux-specific state management, includes reducers, actions, etc.
  • typings - Misc one-off typings

Design Considerations

This repo uses Redux for state management. Please keep in mind the three principles found here.

We also want to keep things as loosely coupled as possible to make unit testing easier. That means most React components should be pure functions of their props and state (some local state is fine, but that we one day might want to persist offline should probably go into the Redux store). It also means writing a lot of the state management code as pure functions so we can pass mocks for things like API clients, stores, reducers, etc. to the functions we're testing.