Kaynağa Gözat

update docs

tags/v1.5.4
Jonathan Cobb 3 yıl önce
ebeveyn
işleme
2154afcbf7
3 değiştirilmiş dosya ile 98 ekleme ve 18 silme
  1. +0
    -17
      docs/dev.md
  2. +2
    -1
      docs/dev_manual.md
  3. +96
    -0
      docs/dev_vagrant.md

+ 0
- 17
docs/dev.md Dosyayı Görüntüle

@@ -9,23 +9,6 @@ and the [Bubble API Reference](https://app.getbubblenow.com/apidocs/)
The easiest way to get started with Bubble is to install [Vagrant](https://www.vagrantup.com/) and use
the Bubble [Vagrantfile](../Vagrantfile).

There are a few environment variables you can use to configure how the Vagrant box is initialized.
Read the Bubble [Vagrantfile](../Vagrantfile) to find out more about these settings.

```shell script
vagrant up
```

This will take a long time to complete. When it is done, you'll have a Vagrant box with
the Bubble source code and all dependencies fully built and ready to run a local launcher.

When your Vagrant box is ready, you can login to it and start the local launcher:

```shell script
vagrant ssh
./bubble/bin/run.sh
```

# Manual Development Setup
If you'd prefer not to use Vagrant or want to build things locally, follow
the [Bubble Manual Development Setup](dev_manual.md) instructions.


+ 2
- 1
docs/dev_manual.md Dosyayı Görüntüle

@@ -30,7 +30,8 @@ required to run the server. At the least, it should contain:
export LETSENCRYPT_EMAIL=user@example.com
```

This defines what email address is used with LetsEncrypt when creating new SSL certificates.
This defines what email address is used with [LetsEncrypt](https://letsencrypt.org/)
when creating new SSL certificates.

If you will be running any tests, create a symlink called `${HOME}/.bubble-test.env`



+ 96
- 0
docs/dev_vagrant.md Dosyayı Görüntüle

@@ -0,0 +1,96 @@
Bubble Vagrant Developer Setup
==============================
[Vagrant](https://www.vagrantup.com/) is a popular way to run pre-packaged software on virtual machines
like VirtualBox and VMware.

# Requirements
Before starting a Vagrant box, you'll need install some software if you don't already have it:

* [VirtualBox](https://www.virtualbox.org/)
* [Vagrant](https://www.vagrantup.com/)

# Configuration
There are a few environment variables you can use to configure how the Vagrant box is initialized.

## Port Selection
Do you have anything already listening on port 8090? If so, set the `BUBBLE_PORT` environment
variable to some free port where the Bubble API can listen. Otherwise, it defaults to 8090.

## Local Launcher and SSL Certificates
Do you want to use this setup as a local launcher to start new Bubbles? If so, define
the `LETSENCRYPT_EMAIL` to an email address that will be registered with
[LetsEncrypt](https://letsencrypt.org/) when your Bubbles need to install SSL certificates.

## Other Settings
Read the Bubble [Vagrantfile](../Vagrantfile) for full information on all settings.

# Starting
To start the Bubble Vagrant box, run:

```shell script
vagrant up
```

To start the Bubble Vagrant box with some environment variables (for example):

```shell script
LETSENCRYPT_EMAIL=someone@example.com BUBBLE_PORT=8080 vagrant up
```

The first time `vagrant up` runs it will take a long time to complete, since it needs to
download and build a lot of stuff. For future runs of `vagrant up`, startup times will be
much faster.

When the command completes, you'll have a Vagrant box with the Bubble source code and all
dependencies fully built and ready to run a local launcher.

# Stopping
To stop the Vagrant box, run:

```shell script
vagrant halt
```

# Deleting
To delete the Vagrant box, run:

```shell script
vagrant destroy [-f]
```

If you supply `-f` then you will not be asked for confirmation.

# Logging In
When your Vagrant box is ready, you can login to it:

```shell script
vagrant ssh
```

## Developing
You can develop directly on the source files in the `${HOME}/bubble` folder, and
recompile and build things there, OR you can develop locally on the host and periodically
synchronize your source and/or build assets to the Vagrant box.

The `/vagrant` directory on the Vagrant guest box is a shared folder. On the host side, it
is the directory that the `Vagrantfile` is in (the top-level of the bubble repository).

For various reasons, the Vagrant box does not build and work in this directory directly. Instead,
when the box is created, `/vagrant` is copied to `${HOME}/bubble` and we run things from there.

So, if you are doing development and building locally (on the host), and want to see
your changes on the Vagrant box (guest), then copy your bubble jar from the host to the guest:

```shell script
cp /vagrant/bubble-server/target/bubble-server-*.jar ${HOME}/bubble/bubble-server/target/
```

To synchronize the entire directory (for example if you're editing sources on
the host and building the jar on the guest):
```shell script
rsync -avzc /vagrant/* /vagrant/.* ${HOME}/bubble/
```

## What's Next
Continue reading the [Bubble Developer Guide](dev.md) for information
on how to update the source code, reset the database, and more.

Yükleniyor…
İptal
Kaydet