README.md

How to develop this project

Prerequisites

1. Node 16 (installation instructions)
2. [email protected] (installation instructions)

Environment variables

If you want to connect dev UI version to your local CasaOS server, you will need to set up a couple of env variables:

1. Copy .env.dev to .env.dev.local (this file is git-ignored)
2. Set VUE_APP_DEV_IP to IP address of your local CasaOS server

Set up dev server

# install tool
yarn global add turbo

# install dependencies
yarn install

# build
yarn dev 

How to build this project

# install tool
yarn global add turbo

# install dependencies
yarn install

# build
yarn build 

How to test this project

yarn test

This project uses vitest for unit tests.

TODO how to deploy this project

How to contribute to this project

CasaOS is a community-driven open source project and the people involved are CasaOS users. That means CasaOS will always need contributions from community members just like you!

• See https://wiki.casaos.io/en/contribute for ways of contribution to CasaOS
• See https://wiki.casaos.io/en/contribute/development if you want to be involved in code contribution specificially

TODO how to license this project

How to contact this project

The word Casa comes from the Spanish word for "home". Project CasaOS originated as a pre-installed system for crowdfunded product ZimaBoard on Kickstarter.

After looking at many systems and software on the market, the team found no server system designed for home scenarios, sadly true.

So, we set out to build this open source project to develop CasaOS with our own hands, everyone in the community, and you.

We believes that through community-driven collaborative innovation and open communication with global developers, we can reshape the digital home experience like never before.

A warm welcome for you to get help or share great ideas in the Discord!