trvrsl

The website for the Traversal Conference.

🎙️

This project is a react-static app utilizing GitHub as a CMS via markdown files located in the docs directory.

Design

Guiceworks created the UX flows, designs and Invision prototype.

Development Requirements

For development, you will need Node.js installed on your machine. A Current or LTS version of Node.js should do the trick and gets installed through homebrew.

brew install node

This project prefers yarn over npm as it's package manager. You can also install yarn through homebrew.

brew install yarn

Next, install the project dependencies:

yarn install

Normal react-static scripts are now available:

yarn build  # Creates the prodution build
yarn flow   # Runs the Flow type checker
yarn lint   # Lints the project using eslint-config-mkitt
yarn start  # Starts the development environment
yarn shipit # Bypass CI and deploy directly to production

View the package.json file for a list of dependencies and configuration options. To learn more about a dependency use npm's home command:

npm home humps

CI and Deployments

The following commands must pass on CI for deployments to occur.

yarn flow
yarn lint

CircleCI will auto deploy to an S3 bucket when the master branch passes.

The S3 bucket uses CloudFront as a CDN.

🙋‍♀️ if you need access to S3 or CloudFront