A Vue SPA for the Chicago ARTCC Website, forked from the Albuquerque ARTCC project. This communicates with the ZAU API in order to deliver content to users.
The Chicago ARTCC website is hereby released under the Creative Commons CC BY-NC-SA 4.0 license. Please ensure you are familiar with the license before contributing to this project. A couple of key takeaways:
- If you choose to share or alter this project, you MUST give credit to the contributors of this project.
- You may NOT use any of this project for commercial purposes.
- If you create a derivative of this project, that project MUST be released under the same license.
https://creativecommons.org/licenses/by-nc-sa/4.0/
Note: The original authors of this codebase are members of the Albuquerque ARTCC listed below:
- Daan Janssen
- Alexandra Robison
- Robby Maura
- Shane Friedman
- Evan Bradley
- Jeremy Werderman
- Cole Connelly (@cdconn00)
- Giovanni Fatelli (@frafire)
If you would like to contribute to this repository, please contact wm@zauartcc.org
Thank you to all contributors, past and present.
Prerequisites:
- Most recent LTS of Node.js, with the corresponding version of npm.
- Doppler installed and logged in.
- Have the ZAU API running locally at
http://localhost:3000. - A basic understanding of Git (branches, merge requests).
If you wish to contribute, please do the following:
- Clone down the repository to your local machine.
- Run
npm install - Run
npm run start:dev
This will compile all of the Vue JS, and start a hot-reloading live server with Vite. Visit http://localhost:8080 to view the app.
In order to maintain consistent code, please adhere to the following guidelines:
- The
masterbranch is protected, therefore you should always be working in a branch. Please name the branchOI-feature_namewhereOIis your operating initials andfeature_nameis a brief description of the feature (II-feedback_formorDJ-admin_stats_page). Please make sure to follow the capitalization standards. - When you have completed your updates, push them to your branch, and then open a merge request to
masterin GitLab. - Please ensure your editor is set up to work with prettier for code formatting.
- We recommend you use VSCode with at least the ESLint plugin installed and configured to auto-fix on save. ESLint can take care of a lot of little mistakes automatically.