Skip to content

Commit

Permalink
Add build state badge
Browse files Browse the repository at this point in the history
  • Loading branch information
elct9620 committed Sep 5, 2017
1 parent 36d9317 commit c77a677
Showing 1 changed file with 45 additions and 13 deletions.
58 changes: 45 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,56 @@
# README
Tamashii Clock-in [![Build Status](https://travis-ci.org/tamashii-io/tamashii-clockin.svg?branch=master)](https://travis-ci.org/tamashii-io/tamashii-clockin)
===

This README would normally document whatever steps are necessary to get the
application up and running.
## Requirements

Things you may want to cover:
* Ruby 2.4.0
* PostgreSQL 9.5+
* Redis
* Node.js
* Yarn

* Ruby version
## Usage

* System dependencies
### Install Dependency

* Configuration
```
$ bundle install
```

* Database creation
### Prepare Database

* Database initialization
If you didn't have database.

* How to run the test suite
```
$ rake db:create
```

* Services (job queues, cache servers, search engines, etc.)
And run migration to create tables.

* Deployment instructions
```
$ rake db:migrate
```

* ...
### Rails

Start Rails server

```
$ rails s
```

### Webpack

Make sure running `webpack-dev-server` to building javascript.

Above require `binstub` setup for your system.

```
$ webpack-dev-server
```

or

```
$ ./bin/webpack-dev-server
```

0 comments on commit c77a677

Please sign in to comment.