soaring 0.1.8 → 0.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +18 -1
- data/lib/soaring/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 3e51c81c87f78445eb16f7c608554d119ddba80f
|
4
|
+
data.tar.gz: 2f420dee5c13092000ee75c4006cd484bb16eb16
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8caa2e81cad920c040cdaafcd76d4844ea58e4e128a450289829cb93158efc7e5febfb273b0ee2d037c057211bbb3f61efc6657205a026a05bcfb00330573658
|
7
|
+
data.tar.gz: e9a2e004dc51f73f38b952310c1a655632bba85950362594fa10fd1ca27d837030bac0a7a1bebd2476d3ab69ef10813e19f9bbdccb0476b09ffd99e6af75d488
|
data/README.md
CHANGED
@@ -5,40 +5,57 @@ This gem provides a collection of command line tools that simplifies the creatio
|
|
5
5
|
## Installation
|
6
6
|
|
7
7
|
Install the gem from rubygems as follow:
|
8
|
-
|
8
|
+
```bash
|
9
9
|
gem install soaring
|
10
|
+
```
|
10
11
|
|
11
12
|
## Creating a new project
|
12
13
|
|
13
14
|
Create a repo on github/gitlab, clone locally and enter project folder:
|
15
|
+
```bash
|
14
16
|
git clone git@github.com:hetznerZA/my-awesome-service-component.git
|
15
17
|
cd my-awesome-service-component
|
18
|
+
```
|
16
19
|
|
17
20
|
Create the fresh project skeleton:
|
21
|
+
```bash
|
18
22
|
soaring init
|
23
|
+
```
|
19
24
|
|
20
25
|
Switch to the appropriate ruby version and install the gem dependencies:
|
26
|
+
```bash
|
21
27
|
rvm use . && bundle install
|
28
|
+
```
|
22
29
|
|
23
30
|
Create an environment.yml file by copying the example and updating to your needs:
|
31
|
+
```bash
|
24
32
|
cp config/environment.yml.example config/environment.yml
|
33
|
+
```
|
25
34
|
|
26
35
|
## Running a service component locally
|
27
36
|
|
28
37
|
Start up a local instance of the service component to check that all is well
|
38
|
+
```bash
|
29
39
|
soaring run
|
40
|
+
```
|
30
41
|
|
31
42
|
This will default to a MRI ruby rack application running with the following defaults:
|
43
|
+
```bash
|
32
44
|
port = 9393
|
33
45
|
environment = 'development'
|
46
|
+
```
|
34
47
|
|
35
48
|
These defaults can be overriden using parameters passed to soaring. View the command line options:
|
49
|
+
```bash
|
36
50
|
soaring -h
|
51
|
+
```
|
37
52
|
|
38
53
|
## Packaging the service component for deployment
|
39
54
|
|
40
55
|
Make sure your git repo is committed and pushed to master. Execute the following command.
|
56
|
+
```bash
|
41
57
|
soaring package
|
58
|
+
```
|
42
59
|
|
43
60
|
The output build zip file will be placed in the builds folder.
|
44
61
|
|
data/lib/soaring/version.rb
CHANGED