platter 0.0.2 → 0.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CODE_OF_CONDUCT.md +13 -0
- data/README.md +148 -1
- data/lib/platter/app_builder.rb +1 -1
- data/lib/platter/version.rb +1 -1
- metadata +4 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: fcaf733eb6093f9492c8e0ee118b1ffae27eca1a
|
4
|
+
data.tar.gz: 46237ff9b45d7f23b06fbe4ba792c982da99a85a
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 545789cc9de6a737bad10f904ff97d6faebf6f104f23bf54c101cbe286317014b9697caa5aac9e6b3882631c2668554e84fec003ab06afedcb9b44da87e8fa37
|
7
|
+
data.tar.gz: c9330071e4d62d52cc004ab91f7d6efd2562e0353398ac19b5beeb0b3ef382ecea68b70b4dc4488382831ecd029ccd75cc912929cbe4a4a853620734ac0f7842
|
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
|
4
|
+
|
5
|
+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
|
6
|
+
|
7
|
+
Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
|
8
|
+
|
9
|
+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
|
10
|
+
|
11
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
|
12
|
+
|
13
|
+
This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
|
data/README.md
CHANGED
@@ -1 +1,148 @@
|
|
1
|
-
#
|
1
|
+
# [Platter](https://github.com/IcaliaLabs/platter)
|
2
|
+
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/platter.svg)](http://badge.fury.io/rb/platter)
|
4
|
+
|
5
|
+
**Platter** is the evolution of [railsAppCustomGenerator](https://github.com/IcaliaLabs/railsAppCustomGenerator) with the intention to create rails app with the basic setup we use at [@icalialabs](http://icalialabs.com). It was created by [Abraham Kuri](https://twitter.com/kurenn) from [Icalia Labs](http://twitter.com/icalialabs).*
|
6
|
+
|
7
|
+
**Platter needs ruby 2.2.1 in order to run**
|
8
|
+
|
9
|
+
## Table of contents
|
10
|
+
- [Installation](#installation)
|
11
|
+
- [Usage](#usage)
|
12
|
+
- [What it actually do?](#what-it-actually-do)
|
13
|
+
- [Bug tracker & feature request](#bug-tracker-&-feature-request)
|
14
|
+
- [Contributing](#contributing)
|
15
|
+
- [Community](#community)
|
16
|
+
- [Heroes](#heroes)
|
17
|
+
- [License](#license)
|
18
|
+
|
19
|
+
## Quick start
|
20
|
+
|
21
|
+
To install the gem you can just run the following command:
|
22
|
+
|
23
|
+
```console
|
24
|
+
% gem install platter
|
25
|
+
```
|
26
|
+
|
27
|
+
You now have access to the `platter` command through the CLI.
|
28
|
+
|
29
|
+
## Usage
|
30
|
+
|
31
|
+
To create a rails app the Icalia way, just use the platter command:
|
32
|
+
|
33
|
+
```console
|
34
|
+
% platter anIcaliaWayRailsApp
|
35
|
+
```
|
36
|
+
|
37
|
+
This will create a rails app with the bare bones to start building an app at [Icalia](http://icalialabs.com)
|
38
|
+
|
39
|
+
### Options for platter
|
40
|
+
|
41
|
+
| Option Name | Description | Alias | Default |
|
42
|
+
| ------------- | ------------- | ------------- | ------------- |
|
43
|
+
| --database | Configure for selected database. PostgreSQL by default. | -d | postgresql |
|
44
|
+
| --skip\_test_unit | Skip Test::Unit files | -T | true |
|
45
|
+
| --skip\_turbo_links | Skips the turbolinks gem | - | true |
|
46
|
+
| --api | Adds API support gems and directory bare bones | - | true |
|
47
|
+
| --skip\_bundle | Don't run bundle install | -B | true |
|
48
|
+
|
49
|
+
### Api
|
50
|
+
--
|
51
|
+
|
52
|
+
```console
|
53
|
+
% platter anIcaliaWayRailsApp --api
|
54
|
+
```
|
55
|
+
|
56
|
+
## What it actually do?
|
57
|
+
|
58
|
+
Platter comes with a lot of goodies.
|
59
|
+
|
60
|
+
**The Gemfile looks like:**
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
source "https://rubygems.org"
|
64
|
+
|
65
|
+
ruby "2.2.1"
|
66
|
+
|
67
|
+
gem "rails", "4.2.1"
|
68
|
+
gem "delayed_job_active_record"
|
69
|
+
gem "jquery-rails"
|
70
|
+
gem "pg"
|
71
|
+
gem "sass-rails", "~> 5.0"
|
72
|
+
gem "coffee-rails", "~> 4.1.0"
|
73
|
+
gem "uglifier", ">= 1.3.0"
|
74
|
+
gem "puma"
|
75
|
+
|
76
|
+
group :development do
|
77
|
+
gem "spring"
|
78
|
+
gem "spring-commands-rspec"
|
79
|
+
gem "web-console"
|
80
|
+
end
|
81
|
+
|
82
|
+
group :development, :test do
|
83
|
+
gem "awesome_print"
|
84
|
+
gem "factory_girl_rails"
|
85
|
+
gem "pry-rails"
|
86
|
+
gem "rspec-rails", "~> 3.1.0"
|
87
|
+
gem "ffaker"
|
88
|
+
end
|
89
|
+
|
90
|
+
# Test gems
|
91
|
+
group :test do
|
92
|
+
gem "database_cleaner"
|
93
|
+
gem "shoulda-matchers"
|
94
|
+
end
|
95
|
+
|
96
|
+
# Production and staging gems
|
97
|
+
group :production, :staging do
|
98
|
+
gem "rails_12factor"
|
99
|
+
gem "exception_notification"
|
100
|
+
end
|
101
|
+
```
|
102
|
+
|
103
|
+
It will also:
|
104
|
+
|
105
|
+
1. Setup the testing environment with Rspec, FactoryGirl, DatabaseCleaner.
|
106
|
+
2. Setup an staging environment to deploy to this environment
|
107
|
+
3. Provides the necessary configuration for the PUMA server run with Foreman
|
108
|
+
4. A setup script for new developers
|
109
|
+
5. Adds configuration for ActiveJob and DelayedJob
|
110
|
+
6. In case of an API, it will add Versionist and ActiveModelSerializers, along with a version 1 structure.
|
111
|
+
7. Adds configuration for ActionMailer to run with Sendgrid
|
112
|
+
8. Setup the project with git providing an initial commit
|
113
|
+
|
114
|
+
|
115
|
+
## Bug tracker & feature request
|
116
|
+
|
117
|
+
For bugs and feature request, head to the [issues](https://github.com/IcaliaLabs/platter/issues) section and if necessary create one.
|
118
|
+
|
119
|
+
|
120
|
+
## Contributing
|
121
|
+
|
122
|
+
Please submit all pull requests against a separate branch. Please follow the standard for naming the variables, mixins, etc.
|
123
|
+
|
124
|
+
In case you are wondering what to attack, we hnow have a milestone with the version to work, some fixes and refactors. Feel free to start one.
|
125
|
+
|
126
|
+
Also remember to respect the [Code of Conduct](https://github.com/IcaliaLabs/platter/blob/master/CODE_OF_CONDUCT.md) for open source projects.
|
127
|
+
|
128
|
+
Thanks!
|
129
|
+
|
130
|
+
## Community
|
131
|
+
|
132
|
+
Keep track of new feautres, development issues and community news.
|
133
|
+
|
134
|
+
* Have a question about anything, email us at weare@icalialabs.com
|
135
|
+
|
136
|
+
|
137
|
+
## Heroes
|
138
|
+
|
139
|
+
**Abraham Kuri**
|
140
|
+
|
141
|
+
+ [http://twitter.com/kurenn](http://twitter.com/kurenn)
|
142
|
+
+ [http://github.com/kurenn](http://github.com/kurenn)
|
143
|
+
+ [http://klout.com/#/kurenn](http://klout.com/#/kurenn)
|
144
|
+
|
145
|
+
|
146
|
+
## Copyright and license
|
147
|
+
|
148
|
+
Code and documentation copyright 2013-2014 Icalia Labs. Code released under [the MIT license](LICENSE).
|
data/lib/platter/app_builder.rb
CHANGED
@@ -122,7 +122,7 @@ gem "active_model_serializers", github: "rails-api/active_model_serializers", br
|
|
122
122
|
#
|
123
123
|
def init_delayed_job
|
124
124
|
generate "delayed_job:active_record"
|
125
|
-
run `bundle exec rake db:migrate`
|
125
|
+
run `bundle exec rake db:create db:migrate`
|
126
126
|
end
|
127
127
|
|
128
128
|
def add_delayed_job_active_job_configuration
|
data/lib/platter/version.rb
CHANGED
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: platter
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.3
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Icalia Labs
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2015-05-
|
12
|
+
date: 2015-05-09 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: bundler
|
@@ -76,6 +76,7 @@ extensions: []
|
|
76
76
|
extra_rdoc_files: []
|
77
77
|
files:
|
78
78
|
- ".gitignore"
|
79
|
+
- CODE_OF_CONDUCT.md
|
79
80
|
- Gemfile
|
80
81
|
- LICENSE.txt
|
81
82
|
- README.md
|
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
118
119
|
version: '0'
|
119
120
|
requirements: []
|
120
121
|
rubyforge_project:
|
121
|
-
rubygems_version: 2.4.
|
122
|
+
rubygems_version: 2.4.5
|
122
123
|
signing_key:
|
123
124
|
specification_version: 4
|
124
125
|
summary: A solution to create custom Rails apps used at @icalialabs
|