ThePain/CasaOS
1
0
Fork 0
mirror of https://github.com/IceWhaleTech/CasaOS.git synced 2025-11-06 22:59:44 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Fixing formatting on developing guide

Browse Source 
Signed-off-by: David Tippett <dtaivpp@gmail.com>
This commit is contained in:
David Tippett 2022-06-17 15:15:57 -04:00
parent 7fbb593827
commit 89d288d4d3
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
DEVELOPING.md
View File

@ -1,34 +1,33 @@
# CasaOS Development # CasaOS Development
Here we will describe the steps required to setup a development with CasaOS. Here we will describe the steps required to setup a development with CasaOS.
── [Setting up development environment](#setting-up-development-environment) ── [Setting up development environment](#setting-up-development-environment)
├── [Pre-requisites](#pre-requisites) ├── [Pre-requisites](#pre-requisites)
├── [1. Fork the Repo](#1.-fork-the-repo) ├── [1. Fork the Repo](#1.-fork-the-repo)
├── [2. Clone the repo down](#2.-clone-the-repo-down) ├── [2. Clone the repo down](#2.-clone-the-repo-down)
└── [3. Install dependencies](#3.-install-dependencies) └── [3. Install dependencies](#3.-install-dependencies)
## Setting up development environment ## Setting up a development environment
In this section we will talk you through the general process of setting up your development environment to get started. In this section we will walk you through the general process of setting up your development environment to get started.
### Pre-requisites ### Pre-requisites
The following must be installed in order to get started. Going over 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). 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 - Go > v1.17.0
- yarn - yarn
- node.js - node.js
### 1. Fork the Repo ### 1. Fork the Repo
Fork the repo onto your own GitHub account for developing. [Fork the repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo) onto your own GitHub account for developing.
### 2. Clone the repo down ### 2. Clone the repo down
1. Navigate into your go workspace (check with `go env GOPATH`). 1. Navigate into your go workspace (check with `go env GOPATH`).
2. 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. 2. 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.
3. Clone down the repo with the following: `git clone --recurse-submodules --remote-submodules https://github.com/<your GitHub Username>/CasaOS.git` 3. Clone down the repo with the following: `git clone --recurse-submodules --remote-submodules https://github.com/<your GitHub Username>/CasaOS.git`
### 3. Install dependencies ### 3. Install dependencies
1. `cd UI` 1. `cd UI`
2. `yarn install` 2. `yarn install`
3. `yarn build` 3. `yarn build`
4. `cd ..` 4. `cd ..`
5. `go get` 5. `go get`