Skip to content

Latest commit

 

History

History
68 lines (47 loc) · 3.16 KB

README.md

File metadata and controls

68 lines (47 loc) · 3.16 KB
Raw

VATUSA - MyVATUSA Frontend

This repository contains the frontend code for the MyVATUSA project. It is built using Vite, VueJS, Typescript and TailwindCSS.

License

The MyVATUSA website is released under the Apache License 2.0. Please familiarize yourself with the license before contributing to this project. Key points to remember:

  1. Attribution: You must give appropriate credit to the original authors of this work, provide a link to the Apache 2.0 License, and indicate if changes were made. This does not suggest that the licensors endorse you or your use of the work.

  2. Redistribution: You may freely distribute the original or modified versions of this work, but you must include a copy of the Apache 2.0 License and a clear attribution to the original authors.

  3. No Warranty: This project is provided "as is" without any warranty. The licensors provide no warranty regarding the work and disclaim liability for all uses of the work, to the fullest extent permitted by applicable law.

  4. State Changes: If you modify the work, you must indicate your changes clearly and not misrepresent the original work.

  5. Patent Grant: The license grants a royalty-free, worldwide, non-exclusive license to use any patent claims owned or controlled by the licensors that are necessary for the work.

  6. Non-Endorsement: The Apache 2.0 License does not grant permission to use the trade names, trademarks, service marks, or product names of the licensors.

For the full text of the Apache 2.0 License, visit: Apache License 2.0

Contributing

If you would like to contribute to this project, please fork the repository and submit a pull request. Please ensure that your code is well-documented and that you have tested your changes before submitting a pull request. If you are unsure of how to contribute, please contact the project maintainer.

Prerequisites:

  • Most recent LTS of Node.js (v20)
  • Yarn, NPM or Bun
  • ESLint (Configure to lint on save, if possible)

Development

Setting up the development environment is simple. First, clone the repository and install the dependencies:

  1. Clone the repo.
git clone https://github.com/VATUSA/MyVATUSA.git
  1. Install the dependencies.
cd MyVATUSA
yarn install

or

cd MyVATUSA
npm install
  1. Run the development server.
yarn dev

or

npm run dev

Development Guidelines

  • Typescript is required for all code. Please ensure that your code is well-typed and that you are using the correct types for all variables.
  • Code Documentation: Make sure your code is adequately commented to explain is functionality.
  • Testing: Thoroughly test your code before submitting a pull request. If you are unsure of how to test your code, please contact the project maintainer.
  • Follow Coding Standards: All code should follow the coding standards set by ESLint.
  • Pull Requests: Describe your changes in detail and provide a clear explanation of what your code does. Include the purpose of your changes and any relevant information that may be useful to the project maintainers. If you are addressing an issue, please include the issue number in your pull request description.