Skip to content

Commit

Permalink
Bump version and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
arielj committed Jun 5, 2021
1 parent 64050d2 commit 294ee30
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 11 deletions.
31 changes: 21 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,6 @@ Run `rails-new-app` command and follow the step by step wizard.

It will use the current default Rails version, so you should install the version you want to use, these generators are currently tested with Rails 6.

# Tests:

Run `rake test`.

### Alternative

If, for any reason, the menu navigation does not work, run `rails-new-app navigation=false`.

## Current configurations:
- Database: MySQL / PostgreSQL / SQLite
- Tests:
Expand Down Expand Up @@ -61,7 +53,15 @@ If, for any reason, the menu navigation does not work, run `rails-new-app naviga
- type of app: standard/minimal/api
- support other databases like MongoDB that require more config

## Adding more configurations and tools:
## For developers

### Setup:

- Clone the repo
- Run `bundle install`
- You can run the app with `./exe/rails-new-app`

### Adding more configurations and tools:

1. Add a new step at `lib/rails-new-app/steps` (or modify an existing one)
2. Collect step config in the `config` hash
Expand All @@ -73,7 +73,7 @@ If, for any reason, the menu navigation does not work, run `rails-new-app naviga

* Steps 5 and 6 are split so we can run `bundle install` once.

## Quick test for developers
### Quick scripted execution:

Since the app uses the STDIN to configure the generator, you can pipe a stream of inputs that a user would do to the command to quickly set all the desired options. For example:

Expand All @@ -99,6 +99,10 @@ cat defaults.txt | rails-new-app

This can eventually be used to share complete setups or generate defaults.

### Tests:

Run `rake test` or `COVERAGE=true rake test`.

## Changelogs

### 0.0.1
Expand All @@ -113,3 +117,10 @@ Added navigation between menus.
- Add a git initial commit
- Added new tools: Faker, pagination gems
- Bug fixing

### 0.1
- Refactor screens (ex steps) handling
- Refactor user input handling to allow easier testing
- Added tests for multiple screens
- Bug fixing (Pagy config, incorrect indexing)
- Added SimpleCov and easier dev setup
2 changes: 1 addition & 1 deletion lib/rails-new-app/version.rb
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module RailsNewApp
VERSION = Gem::Version.new("0.0.3")
VERSION = Gem::Version.new("0.1.0")
end

0 comments on commit 294ee30

Please sign in to comment.