Welcome to the VivaDoc web client, which is a SPA. This is what is hosted at vivadoc.io. It is built in Elm.
Project structure forked from this semi-official open source elm SPA example.
I've added WebPack thanks to this repo being a helpful example.
For styling I've went with Bulma, a free and open-source solution. It's been lovely.
Please message me at [email protected] if you are interested in contributing to the web-client with CONTRIBUTER in
the subject. We are really looking for contributors and would love your help. If you enjoy working in Elm and on
open source projects, this could be a good fit for you, don't hesitate to email me.
To be able to develop on the project you will need to set up a GitHub app to test out your code or use our staging GitHub app. Either way, you'll want to shoot me an email so I can help get you setup.
npm install
npm run dev
You will want to have the API up and running otherwise the web-client will be entirely useless. Check out our nodes services repository to see how to launch the API.
npm run prod
You will need to make sure that you have set the correct fields in the webpack config file. It currently has our production API, but if you want to re-launch your own version of VivaDoc make sure to change those fields to your API URI.