Skip to content

Commit

Permalink
Merge pull request #4 from infracloudio/update-readme
Browse files Browse the repository at this point in the history
update ror readme
  • Loading branch information
samkulkarni20 authored Oct 30, 2023
2 parents 2c20dc1 + 60fd242 commit 0c1b6ea
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 27 deletions.
13 changes: 12 additions & 1 deletion Acornfile
Original file line number Diff line number Diff line change
@@ -1,14 +1,25 @@
name: "Ruby on Rails Sample Acorn"
description: "Acorn running a sample Ruby on Rails app"
readme: "./README.md"
icon: "./rails.svg"

services: db: image: "ghcr.io/acorn-io/mariadb:v10.11.5-1"
args: {
rordbname: "rordb"
}

services: db: {
image: "ghcr.io/acorn-io/mariadb:v10.11.5-1"
serviceArgs: {
dbName: args.rordbname
}
}

containers: web: {
build: {
context: "./src"
dockerfile: "./src/Dockerfile"
}
consumes: ["db"]
if args.dev{
dirs: {
"/app": "./src"
Expand Down
30 changes: 4 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,11 @@
# Acorn for Ruby on Rails sample app - Article App
======

This is an Acorn for the sample Ruby on Rails Article app following Offical Ruby on rails [Getting Started](https://guides.rubyonrails.org/getting_started.html) section.This sample Article app Implements CRUD where you can create, edit and delete your Articles.

## Deploy the Ruby on Rails App

You can deploy the sample web app on the Acorn SaaS Platform with following simple steps.

1. Login to the [Acorn SaaS Platform](https://beta.acorn.io/) using the Github Sign-In option with your Github user.
2. Select the "Create Acorn" option.
3. Choose the source for deploying your Acorns
* Select "From Acorn Image" to deploy the sample Application
* Provide a name such as `Ruby on Rails Sample Acorn` and keeping Project's default Region, type in the below Acorn image and choose Create
```bash
ghcr.io/infracloudio/ruby-on-rails-acorn:v6.1.4-0
```
4. Now the sample App is provisioned on Acorn SaaS Platform and is available for 2hrs. Upgrade to pro account to keep it running longer.
5. Once the Acorn is running, you can access it by clicking the Endpoint or the redirect link.

## Acorn Ruby on Rails App Details
[Ruby on Rails](https://rubyonrails.org/), is a web application framework that has revolutionized the way we build modern web applications. It's known for its "convention over configuration" philosophy, which simplifies development tasks and allows programmers to focus on building exceptional features.

The Acorn Dashboard is integrated with multiple features such as Events, Logs, Details and accessing the Shell of the Application. Details include the CPU, Memory, Network, Latency, Requests and Errors for the Application.

Explore various available options by clicking the Menu option on your Acorn App.

For more details on using the Acorn Dashboard, check this link - [https://beta-docs.acorn.io/getting-started#exploring-the-acorn-dashboard](https://beta-docs.acorn.io/getting-started#exploring-the-acorn-dashboard)
This is an Acorn for the sample Ruby on Rails Article app following Offical Ruby on rails [Getting Started](https://guides.rubyonrails.org/getting_started.html) section.This sample Article app Implements CRUD where you can create, edit and delete your Articles.

## What next?
After deploying you can edit the Acorn Application or remove it if no longer needed.
## Configure the Ruby on Rails App

1. Click the Edit option to edit your Acorn's Image. Toggle the Advanced Options switch for additional edit options.
2. Remove the Acorn by selecting the Remove option from your Acorn dashboard.
Ruby on rails uses mariadb as the database and it is been used as the [services](https://docs.acorn.io/reference/acornfile#services-consuming) . If you are using Advanace Options on Acorn Platform you can provide the `rordbname`. By default it will be named as `rordb`.
1 change: 1 addition & 0 deletions rails.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0c1b6ea

Please sign in to comment.