Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
emkshv committed Jun 26, 2023
1 parent 2f894a6 commit f7adbe0
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
Rails 7.1, Devise, Docker, Docker Compose, Graphana
A mini-starter Rails 7.0.5 web application

* Devise authentication with DaisyUI forms
* Grafana and Prometheus metrics (using the Yabeda framework)
* Docker container

### How to run the application using Docker

Expand All @@ -7,7 +11,7 @@ Before starting, make sure you have Docker and Docker Compose installed.
##### Clone the Repository

```
git clone https://github.com/emakrashov/rails-docker.git
git clone https://github.com/rails-starter-docker-app/rails-docker.git
cd rails-docker
```

Expand Down Expand Up @@ -42,7 +46,19 @@ This will build the Docker image and start the application and database services

##### Access the Application

The application should now be running at http://localhost:3000.
Once the containers are up and running, you can access the application and Grafana in your browser.

Application: http://localhost:4000
Grafana: http://localhost:3000

#### Setting up Grafana

To monitor the application with Grafana, you will need to add Prometheus as a data source.

* Log in to Grafana (default credentials are `admin`/`admin`).
* Go to `Configuration` > `Data Sources` from the left-hand menu.
* Click `Add data source` and select `Prometheus`.
* In the HTTP section, set the URL to http://prometheus:9090 (as defined in docker-compose.yml) and click `Save & Test`.

### How to run tests locally

Expand Down

0 comments on commit f7adbe0

Please sign in to comment.