Add setup in md

This commit is contained in:
adrinr 2023-02-02 12:36:25 +00:00
parent df1105ae2b
commit 4b9d178086
2 changed files with 81 additions and 31 deletions

View File

@ -9,7 +9,6 @@ From opening a bug report to creating a pull request: every contribution is appr
- [Glossary of Terms](#glossary-of-terms) - [Glossary of Terms](#glossary-of-terms)
- [Contributing to Budibase](#contributing-to-budibase) - [Contributing to Budibase](#contributing-to-budibase)
## Not Sure Where to Start? ## Not Sure Where to Start?
Budibase is a low-code web application builder that creates svelte-based web applications. Budibase is a low-code web application builder that creates svelte-based web applications.
@ -77,24 +76,44 @@ Component libraries are collections of components as well as the definition of t
## Contributing to Budibase ## Contributing to Budibase
* Please maintain the existing code style. - Please maintain the existing code style.
* Please try to keep your commits small and focused. - Please try to keep your commits small and focused.
* Please write tests. - Please write tests.
* If the project diverges from your branch, please rebase instead of merging. This makes the commit graph easier to read. - If the project diverges from your branch, please rebase instead of merging. This makes the commit graph easier to read.
* Once your work is completed, please raise a PR against the `develop` branch with some information about what has changed and why. - Once your work is completed, please raise a PR against the `develop` branch with some information about what has changed and why.
### Getting Started For Contributors ### Getting Started For Contributors
#### 1. Prerequisites #### 1. Prerequisites
NodeJS Version `14.x.x` ##### 1.1 NodeJs and python
*yarn -* `npm install -g yarn` - NodeJS version `14.x.x`
- Python version `3.x`
*jest* - `npm install -g jest` ##### 1.1.1 Using asdf (recommended)
Asdf is a package manager that allows managing multiple dependencies.
If can be installed either:
1. Run script (recommended): `./scripts/install-contributor-dependencies.sh`
2. Or, manual installation steps: https://asdf-vm.com/guide/getting-started.html
- asdf plugin add nodejs
- asdf plugin add python
##### 1.1.2 Using NVM
https://github.com/nvm-sh/nvm#installing-and-updating
---
#### 1.2 Install yarn
_yarn -_ `npm install -g yarn`
#### 2. Clone this repository #### 2. Clone this repository
@ -172,30 +191,38 @@ A combination of environment variables controls the mode budibase runs in.
Yarn commands can be used to mimic the different modes as described in the sections below: Yarn commands can be used to mimic the different modes as described in the sections below:
#### Self Hosted #### Self Hosted
The default mode. A single tenant installation with no usage restrictions. The default mode. A single tenant installation with no usage restrictions.
To enable this mode, use: To enable this mode, use:
``` ```
yarn mode:self yarn mode:self
``` ```
#### Cloud #### Cloud
The cloud mode, with account portal turned off. The cloud mode, with account portal turned off.
To enable this mode, use: To enable this mode, use:
``` ```
yarn mode:cloud yarn mode:cloud
``` ```
#### Cloud & Account #### Cloud & Account
The cloud mode, with account portal turned on. This is a replica of the mode that runs at https://budibase.app The cloud mode, with account portal turned on. This is a replica of the mode that runs at https://budibase.app
To enable this mode, use: To enable this mode, use:
``` ```
yarn mode:account yarn mode:account
``` ```
### CI ### CI
An overview of the CI pipelines can be found [here](../.github/workflows/README.md)
An overview of the CI pipelines can be found [here](../.github/workflows/README.md)
### Pro ### Pro
@ -214,6 +241,7 @@ The `yarn bootstrap` command can be used to replace the NPM supplied dependency
### Troubleshooting ### Troubleshooting
Sometimes, things go wrong. This can be due to incompatible updates on the budibase platform. To clear down your development environment and start again follow **Step 6. Cleanup**, then proceed from **Step 3. Install and Build** in the setup guide above to create a fresh Budibase installation. Sometimes, things go wrong. This can be due to incompatible updates on the budibase platform. To clear down your development environment and start again follow **Step 6. Cleanup**, then proceed from **Step 3. Install and Build** in the setup guide above to create a fresh Budibase installation.
### Running tests ### Running tests
#### End-to-end Tests #### End-to-end Tests
@ -226,12 +254,11 @@ yarn test:e2e
Or if you are in the builder you can run `yarn cy:test`. Or if you are in the builder you can run `yarn cy:test`.
### Other Useful Information ### Other Useful Information
* The contributors are listed in [AUTHORS.md](https://github.com/Budibase/budibase/blob/master/.github/AUTHORS.md) (add yourself). - The contributors are listed in [AUTHORS.md](https://github.com/Budibase/budibase/blob/master/.github/AUTHORS.md) (add yourself).
* This project uses a modified version of the MPLv2 license, see [LICENSE](https://github.com/budibase/server/blob/master/LICENSE). - This project uses a modified version of the MPLv2 license, see [LICENSE](https://github.com/budibase/server/blob/master/LICENSE).
* We use the [C4 (Collective Code Construction Contract)](https://rfc.zeromq.org/spec:42/C4/) process for contributions. - We use the [C4 (Collective Code Construction Contract)](https://rfc.zeromq.org/spec:42/C4/) process for contributions.
Please read this if you are unfamiliar with it. Please read this if you are unfamiliar with it.

View File

@ -0,0 +1,23 @@
# Install brew
if ! command -v brew &> /dev/null
then
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
fi
# Install and setup asdf
if ! command -v asdf &> /dev/null
then
brew install asdf
if test -f ~/.bashrc; then
echo -e "\n. $(brew --prefix asdf)/asdf.sh" >> ~/.bashrc
fi
if test -f ~/.zshrc; then
echo -e "\n. $(brew --prefix asdf)/asdf.sh" >> ~/.zshrc
fi
fi
# Install ASDF Plugins
asdf plugin add nodejs
asdf plugin add python