Removing contributing documentation which is out of date, the main CONTRIBUTING document covers everything required.
This commit is contained in:
mike12345567
parent
2480388123
commit
cf45b8da4f
|
|
@ -1,76 +0,0 @@
|
||||||
## Dev Environment on Debian 11
|
|
||||||
|
|
||||||
### Install NVM & Node 14
|
|
||||||
|
|
||||||
NVM documentation: https://github.com/nvm-sh/nvm#installing-and-updating
|
|
||||||
|
|
||||||
Install NVM
|
|
||||||
|
|
||||||
```
|
|
||||||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
Install Node 14
|
|
||||||
|
|
||||||
```
|
|
||||||
nvm install 14
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install npm requirements
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install -g yarn jest lerna
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install Docker and Docker Compose
|
|
||||||
|
|
||||||
```
|
|
||||||
apt install docker.io
|
|
||||||
pip3 install docker-compose
|
|
||||||
```
|
|
||||||
|
|
||||||
### Clone the repo
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/Budibase/budibase.git
|
|
||||||
```
|
|
||||||
|
|
||||||
### Check Versions
|
|
||||||
|
|
||||||
This setup process was tested on Debian 11 (bullseye) with version numbers show below. Your mileage may vary using anything else.
|
|
||||||
|
|
||||||
- Docker: 20.10.5
|
|
||||||
- Docker-Compose: 1.29.2
|
|
||||||
- Node: v14.20.1
|
|
||||||
- Yarn: 1.22.19
|
|
||||||
- Lerna: 5.1.4
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
```
|
|
||||||
cd budibase
|
|
||||||
yarn setup
|
|
||||||
```
|
|
||||||
|
|
||||||
The yarn setup command runs several build steps i.e.
|
|
||||||
|
|
||||||
```
|
|
||||||
node ./hosting/scripts/setup.js && yarn && yarn build && yarn dev
|
|
||||||
```
|
|
||||||
|
|
||||||
So this command will actually run the application in dev mode. It creates .env files under `./packages/server` and `./packages/worker` and runs docker containers for each service via docker-compose.
|
|
||||||
|
|
||||||
The dev version will be available on port 10000 i.e.
|
|
||||||
|
|
||||||
http://127.0.0.1:10000/builder/admin
|
|
||||||
|
|
||||||
### File descriptor issues with Vite and Chrome in Linux
|
|
||||||
|
|
||||||
If your dev environment stalls forever, with some network requests stuck in flight, it's likely that Chrome is trying to open more file descriptors than your system allows.
|
|
||||||
To fix this, apply the following tweaks.
|
|
||||||
|
|
||||||
Debian based distros:
|
|
||||||
Add `* - nofile 65536` to `/etc/security/limits.conf`.
|
|
||||||
|
|
||||||
Arch:
|
|
||||||
Add `DefaultLimitNOFILE=65536` to `/etc/systemd/system.conf`.
|
|
||||||
|
|
@ -1,84 +0,0 @@
|
||||||
## Dev Environment on MAC OSX 12 (Monterey)
|
|
||||||
|
|
||||||
### Install Homebrew
|
|
||||||
|
|
||||||
Install instructions [here](https://brew.sh/)
|
|
||||||
|
|
||||||
| **NOTE**: If you are working on a M1 Apple Silicon which is running Z shell, you could need to add
|
|
||||||
`eval $(/opt/homebrew/bin/brew shellenv)` line to your `.zshrc`. This will make your zsh to find the apps you install
|
|
||||||
through brew.
|
|
||||||
|
|
||||||
### Install Node
|
|
||||||
|
|
||||||
Budibase requires a recent version of node 14:
|
|
||||||
|
|
||||||
```
|
|
||||||
brew install node npm
|
|
||||||
node -v
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install npm requirements
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install -g yarn jest lerna
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install Docker and Docker Compose
|
|
||||||
|
|
||||||
```
|
|
||||||
brew install docker docker-compose
|
|
||||||
```
|
|
||||||
|
|
||||||
### Clone the repo
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/Budibase/budibase.git
|
|
||||||
```
|
|
||||||
|
|
||||||
### Check Versions
|
|
||||||
|
|
||||||
This setup process was tested on Mac OSX 12 (Monterey) with version numbers shown below. Your mileage may vary using anything else.
|
|
||||||
|
|
||||||
- Docker: 20.10.14
|
|
||||||
- Docker-Compose: 2.6.0
|
|
||||||
- Node: 14.20.1
|
|
||||||
- Yarn: 1.22.19
|
|
||||||
- Lerna: 5.1.4
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
```
|
|
||||||
cd budibase
|
|
||||||
yarn setup
|
|
||||||
```
|
|
||||||
|
|
||||||
The yarn setup command runs several build steps i.e.
|
|
||||||
|
|
||||||
```
|
|
||||||
node ./hosting/scripts/setup.js && yarn && yarn build && yarn dev
|
|
||||||
```
|
|
||||||
|
|
||||||
So this command will actually run the application in dev mode. It creates .env files under `./packages/server` and `./packages/worker` and runs docker containers for each service via docker-compose.
|
|
||||||
|
|
||||||
The dev version will be available on port 10000 i.e.
|
|
||||||
|
|
||||||
http://127.0.0.1:10000/builder/admin
|
|
||||||
|
|
||||||
| **NOTE**: If you are working on a M1 Apple Silicon, you will need to uncomment `# platform: linux/amd64` line in
|
|
||||||
[hosting/docker-compose-dev.yaml](../hosting/docker-compose.dev.yaml)
|
|
||||||
|
|
||||||
### Troubleshootings
|
|
||||||
|
|
||||||
#### Yarn setup errors
|
|
||||||
|
|
||||||
If there are errors with the `yarn setup` command, you can try installing nvm and node 14. This is the same as the instructions for Debian 11.
|
|
||||||
|
|
||||||
#### Node 14.20.1 not supported for arm64
|
|
||||||
|
|
||||||
If you are working with M1 or M2 Mac and trying the Node installation via `nvm`, probably you will find the error `curl: (22) The requested URL returned error: 404`.
|
|
||||||
|
|
||||||
Version `v14.20.1` is not supported for arm64; in order to use it, you can switch the CPU architecture for this by the following command:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
arch -x86_64 zsh #Run this before nvm install
|
|
||||||
```
|
|
||||||
|
|
@ -1,92 +0,0 @@
|
||||||
## Dev Environment on Windows 10/11 (WSL2)
|
|
||||||
|
|
||||||
### Install WSL with Ubuntu LTS
|
|
||||||
|
|
||||||
Enable WSL 2 on Windows 10/11 for docker support.
|
|
||||||
|
|
||||||
```
|
|
||||||
wsl --set-default-version 2
|
|
||||||
```
|
|
||||||
|
|
||||||
Install Ubuntu LTS.
|
|
||||||
|
|
||||||
```
|
|
||||||
wsl --install Ubuntu
|
|
||||||
```
|
|
||||||
|
|
||||||
Or follow the instruction here:
|
|
||||||
https://learn.microsoft.com/en-us/windows/wsl/install
|
|
||||||
|
|
||||||
### Install Docker in windows
|
|
||||||
|
|
||||||
Download the installer from docker and install it.
|
|
||||||
|
|
||||||
Check this url for more detailed instructions:
|
|
||||||
https://docs.docker.com/desktop/install/windows-install/
|
|
||||||
|
|
||||||
You should follow the next steps from within the Ubuntu terminal.
|
|
||||||
|
|
||||||
### Install NVM & Node 14
|
|
||||||
|
|
||||||
NVM documentation: https://github.com/nvm-sh/nvm#installing-and-updating
|
|
||||||
|
|
||||||
Install NVM
|
|
||||||
|
|
||||||
```
|
|
||||||
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
|
|
||||||
```
|
|
||||||
|
|
||||||
Install Node 14
|
|
||||||
|
|
||||||
```
|
|
||||||
nvm install 14
|
|
||||||
```
|
|
||||||
|
|
||||||
### Install npm requirements
|
|
||||||
|
|
||||||
```
|
|
||||||
npm install -g yarn jest lerna
|
|
||||||
```
|
|
||||||
|
|
||||||
### Clone the repo
|
|
||||||
|
|
||||||
```
|
|
||||||
git clone https://github.com/Budibase/budibase.git
|
|
||||||
```
|
|
||||||
|
|
||||||
### Check Versions
|
|
||||||
|
|
||||||
This setup process was tested on Windows 11 with version numbers show below. Your mileage may vary using anything else.
|
|
||||||
|
|
||||||
- Docker: 20.10.7
|
|
||||||
- Docker-Compose: 2.10.2
|
|
||||||
- Node: v14.20.1
|
|
||||||
- Yarn: 1.22.19
|
|
||||||
- Lerna: 5.5.4
|
|
||||||
|
|
||||||
### Build
|
|
||||||
|
|
||||||
```
|
|
||||||
cd budibase
|
|
||||||
yarn setup
|
|
||||||
```
|
|
||||||
|
|
||||||
The yarn setup command runs several build steps i.e.
|
|
||||||
|
|
||||||
```
|
|
||||||
node ./hosting/scripts/setup.js && yarn && yarn build && yarn dev
|
|
||||||
```
|
|
||||||
|
|
||||||
So this command will actually run the application in dev mode. It creates .env files under `./packages/server` and `./packages/worker` and runs docker containers for each service via docker-compose.
|
|
||||||
|
|
||||||
The dev version will be available on port 10000 i.e.
|
|
||||||
|
|
||||||
http://127.0.0.1:10000/builder/admin
|
|
||||||
|
|
||||||
### Working with the code
|
|
||||||
|
|
||||||
Here are the instructions to work on the application from within Visual Studio Code (in Windows) through the WSL. All the commands and files are within the Ubuntu system and it should run as if you were working on a Linux machine.
|
|
||||||
|
|
||||||
https://code.visualstudio.com/docs/remote/wsl
|
|
||||||
|
|
||||||
Note you will be able to run the application from within the WSL terminal and you will be able to access the application from the a browser in Windows.
|
|
||||||
Loading…
Reference in New Issue