README.md in localtower-0.1.7 vs README.md in localtower-0.1.8

- old
+ new

@@ -1,6 +1,8 @@ -# Localtower +<p align="center"> +<img src="https://raw.githubusercontent.com/damln/localtower/master/public/logo-localtower-white-300.png" alt="Localtower"> +</p> ### See the schema ![Schema](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v0.1.6/1_schema.png) ### Create a model @@ -13,45 +15,61 @@ ![Migrations](https://raw.githubusercontent.com/damln/localtower/master/public/screenshots/v0.1.6/4_migrations.png) ## INSTALL -Add to your Gemfile: +Only tested with Rails 4.2 and Rails 5.1 (should work with any Rails 4.2+ application). +Only tested with PostgreSQL. - # In your Gemfile +Add to your `Gemfile` file: +```ruby +group :development do + gem "localtower" +end +``` - group :development do - gem "localtower" - end +If you want the latest master branch, add to your `Gemfile` file following: +```ruby +group :development do + gem "localtower", github: "damln/localtower" +end +``` -In your terminal: +Run command in your terminal: +```bash +bundle install +``` - bundle install +Add to your `config/routes.rb`: +```ruby +if Rails.env.development? + mount Localtower::Engine, at: "localtower" +end +``` -Add to your routes: +## Usage - # in config/routes.rb +Open your browser at [http://localhost:3000/localtower](http://localhost:3000/localtower). - if Rails.env.development? - mount Localtower::Engine, at: "localtower" - end +## RSpec -## USAGE +Create a `spec/dummy/.env` file with the credentials to your PostgreSQL Database. It should look like this: -Open your browser at: `http://localhost:3000/localtower` +``` +LOCALTOWER_PG_USERNAME="admin" +LOCALTOWER_PG_PASSWORD="root_or_smething" +``` -## TEST +Run the spec: +```bash +bundle install +bundle exec rspec spec/ +``` -Create a .env file inside the spec/dummy folder with the credentials to your PostgreSQL Database. It should look like this: +Notes: +Tests are currently very slow because this is testing rails commands so it boots the framework for each test. Zeus or spring should be introduced. -spec/dummy/.env: +## Contribute - LOCALTOWER_PG_USERNAME="admin" - LOCALTOWER_PG_PASSWORD="root_or_smething" +Thanks for reporting issues, I'll do my best. -Run the spec: - - bundle install - bundle exec rspec spec/ - -Notes: -Tests are currently very slow because this is testing rails commands so it boots the rails for each test. Zeus or spring should be introced. +[![Analytics](https://ga-beacon.appspot.com/UA-93841935-1/github-readme?pixel)](https://github.com/damln/localtower)