Table of Contents
- Node.js 21.1.0 or later
- pnpm 8.9.2 or later
- Linux preferred
- Clone the repo
git clone https://github.com/sxyalliance/vegas.git && cd vegas
- Install dependencies
pnpm install
- Setup environment variables
Then edit
cp .env.example .env
.env
to set your environment variables. - Start the development server
pnpm run dev
- Open localhost:5173 to see the app.
Please refer to Contributing for more information.
Refer to SXYA Development Backlog for our development roadmap.
See the open issues for a list of proposed features (and known issues).
- Top Feature Requests (Add your votes using the 👍 reaction)
- Top Bugs (Add your votes using the 👍 reaction)
- Newest Bugs
Reach out to the maintainer at one of the following places:
- GitHub issues
- Contact options listed on this GitHub profile
If you want to say thank you or/and support active development of Vegas:
- Add a GitHub Star to the project.
- Tweet about the Vegas.
- Write interesting articles about the project on Dev.to, Medium or your personal blog.
Together, we can make Vegas better!
First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
Please read our contribution guidelines, and thank you for being involved!
The original setup of this repository is by Sunxyw, and then maintained by the SXYA Press Department.
For a full list of all authors and contributors, see the contributors page.
Vegas follows good practices of security, but 100% security cannot be assured. Vegas is provided "as is" without any warranty. Use at your own risk.
For more information and to report security issues, please refer to our security documentation.
This project is licensed under the Apache Software License 2.0.
See LICENSE for more information.
[?] If your work was funded by any organization or institution, acknowledge their support here. In addition, if your work relies on other software libraries, or was inspired by looking at other work, it is appropriate to acknowledge this intellectual debt too.