jtorreggiani / learning-app-rails

App for learning rails

Learning Rails

This repository an web application built with Ruby on Rails designed to help learn about the framework and best practices for web development.

Technology Stack

• Git for version control and collaboration
• Docker for the development environment
• Ruby 3.2.0 for the core programming language
• Ruby on Rails for the full stack development framework
• PostgreSQL for the database
• TailwindCSS for the CSS framework
• Digital Ocean App Platform for deploying to production

Development Environment

This project is setup to use Docker for local development. Assuming you already have Docker desktop installed you should be able to run the following commands to get up and running.

docker compose build
docker compose up

Run the web service container to pull up a shell.

docker compose run web bash

Run rails commands from the console.

bin/rails g controller ExampleController index

Review running containers.

docker ps -a

You should see output that looks something like this. Note that the ps command will output other columns not included in this snippet.

CONTAINER ID   IMAGE                    COMMAND                  NAMES
ed3abd23aaae   learning-app-rails-web   "sh -c bin/dev"          learning-app-rails-web-1
2fca87f252c8   redis                    "docker-entrypoint.s…"   learning-app-rails-redis-1
0778d0d288fc   postgres                 "docker-entrypoint.s…"   learning-app-rails-db-1

Connect to a running instance of web

docker exec -it [CONTAINER_ID] bash

Developing on your host machine

If you would like to run the application without Docker you will need Ruby version 3.2.0 running locally and setup a Postgres Database and update the database.yml file with the corresponding values.

Directory Structure

This application follows all of the folder organization conventions for a Rails application.

├── app
├── bin
├── config
├── data
├── db
├── docs
├── lib
├── log
├── public
├── storage
├── test
├── tmp
├── vendor
├── config.ru
├── Dockerfile
├── docker-compose.yml
├── Gemfile
├── Gemfile.lock
├── Procfile.dev
├── README.md
└── Rakefile

Testing

This project uses Ruby-on-Rails built-in testing utilities with all of the tests located in the /test directory.

Use the docker-compose.test.yml to spin up a container dedicated to running the tests.

docker compose -f docker-compose.test.yml run web bash
rails test

Running the tests you should see the output.

Rebuilding...

Done in 289ms.
required simplecov
Running 26 tests in a single process (parallelization threshold is 50)
Run options: --seed 36466

# Running:
..........................
Finished in 1.009284s, 25.7608 runs/s, 60.4389 assertions/s.
26 runs, 61 assertions, 0 failures, 0 errors, 0 skips
Coverage report generated for Minitest to /app/coverage. 107 / 171 LOC (62.57%) covered.

Environment Variables

Each environment needs multiple variables to be set to be able to run correctly.

ACCESS_KEY_ID=
SECRET_ACCESS_KEY=
SECRET_KEY_BASE=
DATABASE_URL=
REDIS_URL=

Deployment

This repository is setup to automatically deploy to Digital Ocean (DO) App platform when code is merged into the main branch. Do handles the heavy lifting for build the application. In the future, we will explore deploying this site to other platforms.

Media Storage

Media uploaded to the app is stored in Digital Ocean Spaces using ActiveStorage.

TODO

• Deploy application to Digital Ocean
• Deploy to Heroku
• Add tests to CI
• Add Ruby linters
• Add Ruby automated documentation
• Add cucumber for feature testing
• Add Sentry for monitoring