Skip to content

contredanse/mfts

Repository files navigation

Material for the spine

Build Status codecov tested with jest styled with prettier

MFS

A movement study webapp converted from Contredanse's "Material for the Spine" DVD-ROM originally written in flash/actionscript.

https://www.materialforthespine.com

License

Source code of this webapp is freely available under MIT license. Video material is subject to copyright to Contredanse editions, Brussels. For support please register for a paid subscription.

Technologies

  • React/Typescript/Webpack.

Contributors

Notes for developers

Install

$ git clone https://github.com/contredanse/mfts.git
$ cd mfts
$ yarn install

Configure

You don't have to but if you want for development to change some environment variables (links, assets url's...

Copy the env.template file into `./env.development.local'.

$ cp ./env/env.template ./env.development.local

Develop

$ yarn dev

then open http://localhost:3001 in your browser.

Check & test

$ yarn lint:fix
$ yarn prettier
$ yarn test

Build

$ yarn build

The build will be available in /dist/public

Production

Server

To fully take advantage of brotli compression, Apache is recommended over Nginx. Really be sure to not cache either service-worker.js and index.html to prevent PWA caching issues.

See notes, root .htaccess and static .htaccess. Note that apache support is build with the project. In other words, nothing to do for apache users.

Deploy

For simple deployments scenarios have a look to the deploy.sh.example.