Frontend of slotlist.info, an ArmA 3 mission planning and slotlist management tool.
The corresponding backend implementation of this project can be found at slotlist-backend.
- Docker 17.12 and up
- Kubernetes 1.7 and up
$ yarnConfiguration will be transpiled into the frontend source code directly. All configuration provided via the process.env JSON object in the build/webpack.ENV.js files will be available via process.env in all Vue.js files. The values of build/webpack.dev.js will be used when running yarn dev, the values of build/webpack.prod.js for yarn build.
Please note that all provided configuration is visible to clients, since they will be included in the JavaScript loaded by the browser. You should not not include any secrets or otherwise confidential data.
Configuration values are only modifyable during transpilation - changing them requires you to rebuild the project.
$ yarn buildOnce transpiled and minifed, you will only have to serve the content of the dist/ folder created. Any webserver that can serve HTML, JS and CSS as well as some small images should suffice, however I suggest using either nginx or Apache2.
Optionally, you can use Docker and the provided Dockerfile to run the frontend using a minimal nginx installation in a Docker container. Please make sure to check and adapt the included nginx configuration in the nginx/ folder as required.
$ docker build -t slotlist-frontend .
$ docker run -p 4000:4000 slotlist-frontendThe easiest way to start developing is by setting up the required Node/Yarn environment and running yarn dev. Your sources will be transpiled using webpack and the original source folder will be watched for changes, automatically rebuilding and reloading as required.
In order to allows for easier development and debugging, the Vue devtools extension for Google Chrome or Mozilla Firefox is highly recommended since it provides additional insight, especially into the vuex store and allows for on-the-fly modifications.
slotlist-frontend was designed to be deployed to a Kubernetes cluster running on the Google Cloud Platform. The k8s/ folder contains the configuration files required to create and run all services. This project also depends on the rest of the infrastructure being set up via the Kubernetes configs provided in the slotlist-backend project. A cloudbuild.yaml file for automatic Docker image builds is provided in the repository root as well.
Generally speaking, slotlist-frontend can be deployed anywhere running a webserver capable of serving static content.
Let's Encrypt provides excellent, free SSL certificates that are easy to integrate into your existing hosting, so there's no reason why you should run your site over plain HTTP!
Please be advised that some configuration values might need modifications should you plan to run your own instance since they have been tailored to work for slotlist.info's main instance. This is especially relevant for the CSP/HPKP headers set - failing to set these properly will result in problems loading your site.
Pull requests are more than welcome - I am grateful for any help, no matter how small it is! For major changes, please open an issue first so proposed modifications can be discussed first.
All pull requests should be submitted to the dev branch - once a feature is fully implemented and tested, it will be merged to the master branch and deployed.
Attributions will be provided in the Contributors file inside the docs/ folder as appropriate.
In additional to development work for the backend or frontend projects, slotlist.info also needs your help in providing accurate and complete translations. We are utilising OneSky to crowd-source our translations and provide an easy interface to manage required strings. Feel free to contribute any translations or suggest a new language by opening an issue on the slotlist-frontend repository.
slotlist-frontend uses Semantic Versioning for releases, every deployment will be tagged with a new, appropriate version - old releases can be found on GitHub's release tab.
slotlist-backend, the backend portion of slotlist.info, written in TypeScript