Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.09 KB

README.md

File metadata and controls

46 lines (30 loc) · 2.09 KB
Raw

Miami ARTCC 2020 - API

An Express app that provides data to UI

License

The Miami 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 derivitive 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 Austin Robison Robby Maura

Contributors

If you would like to contribute to this repository, please contact [email protected]

Thank you to all contributors, past and present.

Contributing

Prerequisites:

  • Most recent LTS of Node.js (v16), with the corresponding version of npm.
  • A basic understanding of Git (branches, merge requests).

If you wish to contribute, please do the following:

  1. Clone down the repository to your local machine.
  2. Run npm install
  3. Run node app.js

There are no DB seeds provided with this project. If you would like to contribute, please contact [email protected] for the dev DB creds.

Contributing Guidelines and Style

In order to maintain consistent code, please adhere to the following guidelines:

  • The master branch is protected, therefore you should always be working in a branch. Please name the branch OI-feature_name where OI is your operating initials and feature_name is a brief description of the feature (II-feedback_form or DJ-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 development in GitLab.
  • Please follow the styleguide for how to format your code.
  • 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.