Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update README.md #40

Merged
merged 2 commits into from
Aug 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,30 @@
# README
# Sample Application with Ruby on Rails

This README would normally document whatever steps are necessary to get the
application up and running.
Ruby Version 3.2.2

Things you may want to cover:
This sample is running on: https://ruby-rails.is-easy-on-scalingo.com/

* Ruby version
## Deploy via Git

* System dependencies
Create an application on https://scalingo.com, then:

* Configuration
```shell
scalingo --app my-app git-setup
git push scalingo master
```

* Database creation
And that's it!

* Database initialization
## Deploy via One-Click

* How to run the test suite
[![Deploy to Scalingo](https://cdn.scalingo.com/deploy/button.svg)](https://dashboard.scalingo.com/create/app?source=https://github.com/Scalingo/sample-ruby-rails#master)

* Services (job queues, cache servers, search engines, etc.)
## Running Locally

* Deployment instructions
```shell
docker compose run web bundle install
docker compose up
```

* ...
The app listens by default on the port 8080 or the one defined in the `PORT`
environment variable.