Skip to content

Latest commit

 

History

History
39 lines (26 loc) · 1.11 KB

README.md

File metadata and controls

39 lines (26 loc) · 1.11 KB
Raw

Launcher

This is the launcher for The Peacock Project.

Installation

  • This project requires Node.js to run.
  • You will also need to enable corepack after installing Node.js, which can be done with:
corepack enable
  • Next, you will also need to install Rust (which is what the launcher backend uses). For convinence, you can grab the Windows installer here.
  • Finally, install the frontend dependencies with:
yarn install

Running

To start the app in development mode, run:

yarn start

Contributing

Want to contribute? Great!

Know Rust, JavaScript, or CSS? That's our stack! Make a Pull Request and you can help us develop a better launcher!

Writing bug reports is cool. You can do that. Or update this readme whenever it's needed.

Thank you to the people who have contributed!

License

This repository is under the Mozilla Public License v2.0. By contributing, you agree that all contributions shall fall under the terms of the license.