pliny
An opinionated toolkit for writing excellent APIs in Ruby.
File Explorer
Download Latest Version (.zip)- lint.yml
- ruby.yml
- pliny-generate
- pliny-new
- pliny-update
- base.rb
- endpoint.rb
- mediator.rb
- migration.rb
- model.rb
- schema.rb
- serializer.rb
- creator.rb
- generator.rb
- updater.rb
- rollbar.rb
- sentry.rb
- encode.rb
- params.rb
- serialize.rb
- zulu_time.rb
- logger.rb
- clear.rb
- seed.rb
- canonical_log_line.rb
- cors.rb
- instruments.rb
- metrics.rb
- request_id.rb
- rescue_errors.rb
- versioning.rb
- db.rake
- schema.rake
- endpoint.erb
- endpoint_acceptance_test.erb
- endpoint_scaffold.erb
- endpoint_scaffold_acceptance_test.erb
- endpoint_test.erb
- mediator.erb
- mediator_test.erb
- migration.erb
- model.erb
- model_migration.erb
- model_test.erb
- serializer.erb
- serializer_test.erb
- canonical_log_line_helpers.rb
- config_helpers.rb
- db_support.rb
- error_reporters.rb
- errors.rb
- log.rb
- metrics.rb
- request_store.rb
- rollbar_logger.rb
- router.rb
- tasks.rb
- utils.rb
- version.rb
- console
- run
- setup
- database.rb
- log.rb
- metrics.rb
- sentry.rb
- config.rb
- puma.rb
- schema.sql
- seeds.rb
- base.rb
- health.rb
- root.rb
- schema.rb
- base.rb
- base.rb
- rubocop.rake
- spec.rake
- application.rb
- initializer.rb
- routes.rb
- .gitkeep
- meta.json
- health_spec.rb
- schema_spec.rb
- auto_define_rack_app.rb
- coverage.rb
- log.rb
- spec_helper.rb
- .env.sample.erb
- .env.test.erb
- .gitignore
- .rspec
- .rubocop_template.yml
- .ruby-version
- app.json.erb
- config.ru
- Gemfile
- LICENSE
- Procfile
- Rakefile
- README.md
- pliny.rb
- base_spec.rb
- endpoint_spec.rb
- mediator_spec.rb
- migration_spec.rb
- model_spec.rb
- schema_spec.rb
- serializer_spec.rb
- creator_spec.rb
- generator_spec.rb
- updater_spec.rb
- rollbar_spec.rb
- sentry_spec.rb
- encode_spec.rb
- params_spec.rb
- serialize_spec.rb
- zulu_time_spec.rb
- logger_spec.rb
- clear_spec.rb
- seed_spec.rb
- canonical_log_line_spec.rb
- cors_spec.rb
- instruments_spec.rb
- metrics_spec.rb
- request_id_spec.rb
- rescue_errors_spec.rb
- versioning_spec.rb
- config.rb
- endpoints.rb
- canonical_log_line_helpers_spec.rb
- config_helpers_spec.rb
- db_support_spec.rb
- error_reporters_spec.rb
- errors_spec.rb
- integration_spec.rb
- log_spec.rb
- metrics_spec.rb
- request_store_spec.rb
- rollbar_logger_spec.rb
- router_spec.rb
- spec_helper.rb
- .gitignore
- .rspec
- .rubocop.yml
- .rubocop_standardrb.yml
- .rubocop_standardrb_overrides.yml
- CHANGELOG.md
- CONTRIBUTING.md
- Gemfile
- LICENSE
- pliny.gemspec
- Rakefile
- README.md
# Installation Guide
1. Get the code
git clone https://github.com/interagent/pliny
Downloads the entire project code from GitHub to your computer.
cd pliny
Moves into the project folder you just downloaded.
2. Ruby
Easy RecommendedPrerequisites
$ bundle exec pliny-generate model artist
Type this command into your terminal and run it.
$ bundle exec pliny-generate mediator artists/creator
Type this command into your terminal and run it.
$ bundle exec pliny-generate endpoint artists
Type this command into your terminal and run it.
$ bundle exec pliny-generate migration fix_something
Type this command into your terminal and run it.
$ bundle exec pliny-generate schema artists
Type this command into your terminal and run it.
If bundle install finishes without errors, continue with the run command from the README (e.g. rails server).
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)