diff --git a/README.md b/README.md index fbadd3a..3d52110 100644 --- a/README.md +++ b/README.md @@ -11,4 +11,28 @@ Noun, Suru verb 1. reading +## Running the project + +### Using npm / yarn + +As this project is built using ReasonML, it requires the bucklescript platform to compile and run. To start the application on a fresh machine run the following commands to start a server at `localhost:3000`: + +* `npm install -g bs-platform` +* `yarn` +* `yarn start` + +### Docker + +Alternatively, docker can be used to run the project. The service will be available at: `localhost:80` + +* `./run-docker.sh` + +## Additional Information + This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). + +* [ReasonML](https://reasonml.github.io/) +* [Reason Scripts](https://github.com/reasonml-community/reason-scripts) +* [Reason React](https://reasonml.github.io/reason-react/) +* [Rationale](https://github.com/jonlaing/rationale) +* [Bs-Jest](https://github.com/glennsl/bs-jest)