- Preface
- Prerequisites
- Node Requirements
- To build locally (Manual)
- For Production
- Contributing
- License
This is the repository for the website of EasyTL (easytl.org). All code is open-source and available for anyone to use. Below is a brief overview of the project, how to build it locally, information regarding production, licensing, and contributing.
If you need to report a security vulnerability, please see the SECURITY.md file.
node 20.13.1
npm 10.8.0
See frontend/package.json for a list of node requirements.
- Clone the repo, make sure you are using the correct branch (currently
main) - Navigate to the
easytldirectory. - First install all required packages, these are in
package.json. Donpm i. Then run the dev server withnpm run dev - Website will be on localhost:5173 (frontend).
EasyTL-Frontend uses the backend from https://github.com/Kakusui/kakusui-org. So if you are setting up the backend, please see the instructions there.
Frontend is hosted on cloudflare pages. To deploy, push to the main branch.
If you would like to contribute, please open an issue or a pull request. No specific guidelines, but remain professional.
As Kakusui is an avid supporter of open-source software, this project is licensed under one of the strongest copyleft licenses available, the GNU Affero General Public License (AGPLv3).
You can find the full text of the license in the LICENSE file.
The AGPLv3 is a copyleft license that promotes the principles of open-source software. It ensures that any derivative works based on this project, as well as any software that interacts with users over a network, must also be distributed under the same AGPLv3 license. This license grants you the freedom to use, modify, and distribute the software.
Please note that this information is a brief summary of the AGPLv3. For a detailed understanding of your rights and obligations under this license, please refer to the full license text.