Skip to content

Commit 77dd626

Browse files
authored
Merge pull request #292 from ashie/add-missing-install-procedure
README.md: Add missing installation procedures
2 parents 68f7eee + d6ed131 commit 77dd626

File tree

1 file changed

+32
-4
lines changed

1 file changed

+32
-4
lines changed

README.md

+32-4
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ And some additional packages (Debian / Ubuntu)
3535
$ fluentd-ui start --daemonize
3636

3737
Access http://localhost:9292 by web browser.
38+
The default account is username="admin" and password="changeme".
3839

3940
### Run under sub path
4041

@@ -46,12 +47,35 @@ Access http://localhost:9292/prefix by web browser.
4647

4748
## Development
4849

50+
### Get the source
51+
4952
$ git clone https://github.com/fluent/fluentd-ui
5053
$ cd fluentd-ui
51-
$ bundle install
52-
$ bin/rails s
5354

54-
Also you need a [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) or chromiumdriver for test.
55+
### Install dependent gems
56+
57+
Use bundler:
58+
59+
$ gem install bundler
60+
$ bundle install --path vendor/bundle
61+
62+
### Install dependent JavaScript packages
63+
64+
Use [yarn](https://yarnpkg.com/).
65+
See https://yarnpkg.com/en/docs/install to install it to your environment.
66+
After install it, run following command:
67+
68+
$ yarn install
69+
70+
### Run fluentd-ui
71+
72+
$ bin/rails server
73+
74+
Access http://localhost:3000 by web browser.
75+
76+
### Run tests
77+
78+
You need [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) or chromiumdriver to run tests.
5579

5680
$ npm install -g chromedriver
5781
Or,
@@ -61,7 +85,11 @@ Also you need a [chromedriver](https://sites.google.com/a/chromium.org/chromedri
6185

6286
NOTE: `chromedriver` executable binary should be located under your `$PATH`.
6387

64-
## Building fluentd-ui.gem
88+
After that you can run tests by following command:
89+
90+
$ bundle exec rake test
91+
92+
### Building fluentd-ui.gem
6593

6694
# Generate ChangeLog.md and increment version
6795
$ bin/rails release:prepare

0 commit comments

Comments
 (0)