Skip to content

Commit

Permalink
Merge pull request #2 from infracloudio/update-readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
samkulkarni20 authored Oct 30, 2023
2 parents 677dfa9 + e6dc1b4 commit dea39bc
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 27 deletions.
11 changes: 10 additions & 1 deletion Acornfile
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
name: "Laravel Sample Acorn"
description: "Acorn running a sample Laravel app"
readme: "./README.md"
icon: "./laravel.svg"

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

services: db: {
image: "ghcr.io/acorn-io/mariadb:v10.11.5-1"
serviceArgs: {
dbName: args.laraveldbname
}
}
containers: {
app: {
build: {
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 Laravel sample app - TODO App
======

This is an Acorn for the sample Laravel TODO app following [this](https://impulsivecode.com/laravel-crud-tutorial-example-for-beginners/) blog post.This sample TODO app Implements CRUD where you can create, edit and delete your task.

## Deploy the Laravel 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 `Laravel Sample Acorn` and keeping Project's default Region, type in the below Acorn image and choose Create
```bash
ghcr.io/infracloudio/laravel-acorn:v10.0.0-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.
[Laravel](https://laravel.com/) is an open-source framework designed to make web development faster, more efficient, and enjoyable. Laravel, is a popular and powerful PHP web application framework that provides the tools and resources to streamline your workflow and create high-quality applications.

## Acorn Laravel App Details

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.
This is an Acorn for the sample Laravel TODO app following [this](https://impulsivecode.com/laravel-crud-tutorial-example-for-beginners/) blog post.This sample TODO app Implements CRUD where you can create, edit and delete your task.

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)
## Configure the Laravel App

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

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.
Laravel 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 `laraveldbname`. By default it will be named as `laraveldb`.
1 change: 1 addition & 0 deletions laravel.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 dea39bc

Please sign in to comment.