VaHI is a standardized grading system for limbal stem cell deficiency.
This is the
wesbiterepository which holds the code for our website.
For more information on what VaHI does/is, please visit vahi.eu.
The website respository holds VaHI's website available at vahi.eu.
This site is build with Vue.js and Nuxt.
We use nuxt generate to build it into a static site that we deploy on Netlify
and hook up to our api.
- node.js
- Clone the respository and install dependencies with NPM (or yarn):
git clone git@github.com:vahicode/website.git
cd website
npm install
- Configure the
VAHI_APIenvironment variable to point to your API (eg:export VAHI="https://api.vahi.eu"). - You can now run
npm run devto serve the site on localhost:3000 - Or run
npm run generateto generate a static site.
The static site (the result of npm run generate can be hosted by any webserver, or by a static hosting service such as Netlify which is free for open-source projects, and comes highly recommended.
We use vue-i18n for translations. If you'd like to add a language, you can simply copy the English language file and translate it.
For example, to add a Spanish translation, copy locales/en.yaml to locales/es.yaml and translate it to Spanish. Keep in mind that these are YAML file with key: value pairs. You should only translate the value and not the key.
Once your translation is ready, run npm run locgen in the project root. Then, add the language to the config file to add it to the site. You will also want to add a flag icon.
Your pull request are welcome here. If you have any questions, please create an issue.
VaHI is licensed under the MIT license. See the License file for more information.