b0dc30277b
* Adding developing guide with env setup Signed-off-by: David Tippett <dtaivpp@gmail.com> * Fixing formatting on developing guide Signed-off-by: David Tippett <dtaivpp@gmail.com> * Switching nav to bulleted list Signed-off-by: David Tippett <dtaivpp@gmail.com> * Forgot a word o_o Signed-off-by: David Tippett <dtaivpp@gmail.com>
1.5 KiB
1.5 KiB
CasaOS Development
Here we will describe the steps required to setup a development environment with CasaOS.
Setting up a development environment
In this section we will walk you through the general process of setting up your development environment to get started.
Pre-requisites
The following must be installed in order to get started. The details of how to install them is outside the scope of this doc, but generally they should be able to be installed with your systems package manager (apt, yum, brew, choco, etc).
- Go > v1.17.0
- yarn
- node.js
1. Fork the Repo
Fork the repo onto your own GitHub account for developing.
2. Clone the repo down
- Navigate into your go workspace (check with
go env GOPATH). - Navigate to the appropriate path for github. It should look something like this:
<path from GOPATH>/github.com/<GitHub Username>/. If it doesn't exist create it. - Clone down the repo with the following:
git clone --recurse-submodules --remote-submodules https://github.com/<your GitHub Username>/CasaOS.git
3. Install dependencies
cd UIyarn installyarn buildcd ..go get