{"id":17826413,"url":"https://github.com/boutquin/ruby-on-rails-7-tutorial-hello","last_synced_at":"2026-07-02T10:31:52.607Z","repository":{"id":258577027,"uuid":"865107303","full_name":"boutquin/Ruby-On-Rails-7-Tutorial-Hello","owner":"boutquin","description":"My work on Michael Hartl's Ruby On Rails 7 Tutorial","archived":false,"fork":false,"pushed_at":"2025-02-20T13:42:26.000Z","size":99,"stargazers_count":0,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-02T12:16:24.488Z","etag":null,"topics":["ruby","ruby-on-rails","tutorial-code"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/boutquin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-30T01:34:10.000Z","updated_at":"2024-11-25T14:54:52.000Z","dependencies_parsed_at":"2024-10-19T16:52:07.725Z","dependency_job_id":"abc855f0-a5ed-4d44-ab21-9493935dd25e","html_url":"https://github.com/boutquin/Ruby-On-Rails-7-Tutorial-Hello","commit_stats":null,"previous_names":["boutquin/ruby-on-rails-7-tutorial-hello"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boutquin%2FRuby-On-Rails-7-Tutorial-Hello","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boutquin%2FRuby-On-Rails-7-Tutorial-Hello/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boutquin%2FRuby-On-Rails-7-Tutorial-Hello/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/boutquin%2FRuby-On-Rails-7-Tutorial-Hello/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/boutquin","download_url":"https://codeload.github.com/boutquin/Ruby-On-Rails-7-Tutorial-Hello/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246811310,"owners_count":20837752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ruby","ruby-on-rails","tutorial-code"],"created_at":"2024-10-27T18:47:38.292Z","updated_at":"2025-09-16T20:56:52.592Z","avatar_url":"https://github.com/boutquin.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ruby On Rails 7 Tutorial Hello App\n\n[![Ruby](https://img.shields.io/badge/Ruby-3.3.5-red.svg)](https://www.ruby-lang.org/en/)\n[![Rails](https://img.shields.io/badge/Rails-7.2.1-red.svg)](https://rubyonrails.org/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n[![Build Status](https://github.com/Boutquin/Ruby-On-Rails-7-Tutorial-Hello/actions/workflows/ci.yml/badge.svg)](https://github.com/Boutquin/Ruby-On-Rails-7-Tutorial-Hello/actions/workflows/ci.yml)\n[![Docker Support](https://img.shields.io/badge/Docker-Supported-blue.svg)](https://www.docker.com/)\n[![Heroku](https://img.shields.io/badge/Heroku-Deployment-blue.svg)](https://heroku.com/)\n[![Discussions](https://img.shields.io/github/discussions/Boutquin/Ruby-On-Rails-7-Tutorial-Hello)](https://github.com/Boutquin/Ruby-On-Rails-7-Tutorial-Hello/discussions)\n\n## Table of Contents\n\n- [Overview](#overview)\n- [Features](#features)\n- [System Requirements](#system-requirements)\n- [Setup](#setup)\n  - [Clone the Repository](#clone-the-repository)\n  - [Install Dependencies](#install-dependencies)\n  - [Database Setup](#database-setup)\n  - [Run the Application](#run-the-application)\n  - [Run the Tests](#run-the-tests)\n  - [Deployment](#deployment)\n- [CI/CD Pipeline](#cicd-pipeline)\n- [Docker](#docker)\n- [Tailwind CSS Integration](#tailwind-css-integration)\n- [Additional Features](#additional-features)\n- [Contributing](#contributing)\n- [Acknowledgements](#acknowledgements)\n- [License](#license)\n\n## Overview\n\nThe **Ruby On Rails 7 Tutorial Hello App** is a simple Ruby on Rails application created by **Pierre G. Boutquin** while working through the [Ruby on Rails Tutorial](https://www.railstutorial.org) by Michael Hartl. The purpose of this project is to help developers familiarize themselves with the basics of building a Rails application and learn best practices. This \"Hello App\" demonstrates basic CRUD (Create, Read, Update, Delete) operations, database interactions, and the fundamental structure of a Rails project.\n\nIt serves as a foundation for further development and enhancement, making it a great starting point for both new developers learning Rails and experienced developers looking to refine their skills.\n\n## Features\n\n- **Ruby 3.3.5**: Built on the latest stable version of Ruby for enhanced performance and security.\n- **Rails 7.2.1**: Leverages the powerful features of Rails 7, including Hotwire for real-time updates and minimal JavaScript requirements.\n- **SQLite** for development and testing, with **PostgreSQL** for production.\n- **Docker** support to ensure that the app can run in a consistent environment regardless of host setup.\n- **GitHub Actions** for continuous integration, ensuring that tests and builds are automatically run on every push or pull request.\n- **Heroku Deployment** for a quick and easy cloud deployment solution.\n- **Tailwind CSS** integration for clean, modern, and responsive designs.\n- **MiniTest** framework for unit testing, ensuring code correctness and robustness.\n- **Yard** for automatically generating documentation from comments within your codebase.\n- **GitHub Discussions**: Enabled to allow for community interaction, support, and contributions.\n\n## System Requirements\n\nTo run this application locally or in production, ensure you have the following installed:\n\n- **Ruby 3.3.5**: You can follow the official [Ruby installation guide](https://www.ruby-lang.org/en/documentation/installation/) to install the correct version for your system.\n- **Rails 7.2.1**: [Install Rails](https://guides.rubyonrails.org/v7.0/getting_started.html#installing-rails) by running `gem install rails -v 7.2.1`.\n- **Bundler**: To manage your gem dependencies, run `gem install bundler`.\n- **SQLite**: Typically pre-installed on macOS and most Linux distributions. You can install it on Windows from [SQLite Downloads](https://www.sqlite.org/download.html).\n- **PostgreSQL**: Ensure PostgreSQL is installed for production environments. [PostgreSQL Installation](https://www.postgresql.org/download/).\n- **Heroku CLI**: [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli) to interact with Heroku for deployment.\n- **Docker**: [Install Docker](https://docs.docker.com/get-docker/) to use containerization for a consistent development and deployment environment.\n\n## Setup\n\n### Clone the Repository\n\nFirst, clone the repository to your local machine:\n\n```bash\ngit clone https://github.com/Boutquin/Ruby-On-Rails-7-Tutorial-Hello.git\ncd Ruby-On-Rails-7-Tutorial-Hello\n```\n\n### Install Dependencies\n\nOnce inside the project directory, install the required Ruby gems using Bundler:\n\n```bash\nbundle install\n```\n\nThis will install all the dependencies defined in the `Gemfile`, including Rails, the test suite, and any required database gems.\n\n### Database Setup\n\nFor development and testing (SQLite):\n\n```bash\nrails db:create\nrails db:migrate\n```\n\nFor production (PostgreSQL):\n\nEnsure your environment variables are configured for PostgreSQL in `config/database.yml`. To set up the production database on Heroku:\n\n```bash\nheroku run rails db:setup\n```\n\n### Run the Application\n\nTo start the Rails server locally, run:\n\n```bash\nrails server\n```\n\nBy default, the server will run on [http://localhost:3000](http://localhost:3000). You can also specify a different port if needed, for example:\n\n```bash\nrails server -p 4000\n```\n\n### Run the Tests\n\nThis project uses MiniTest for testing. To run all tests:\n\n```bash\nrails test\n```\n\nYou can also run specific test files or methods as needed, using:\n\n```bash\nrails test path/to/test_file.rb\n```\n\nEnsure all tests are passing before pushing changes or deploying to production.\n\n### Deployment\n\n#### Heroku Deployment\n\nTo deploy to Heroku:\n\n1. Install the [Heroku CLI](https://devcenter.heroku.com/articles/heroku-cli).\n2. Create a Heroku app:\n\n   ```bash\n   heroku create\n   ```\n\n3. Deploy the app by pushing to Heroku:\n\n   ```bash\n   git push heroku main\n   ```\n\n4. Set up the production database:\n\n   ```bash\n   heroku run rails db:migrate\n   ```\n\nYou can now access your app via the URL provided by Heroku.\n\n## CI/CD Pipeline\n\nThis project uses **GitHub Actions** to automate testing and ensure continuous integration. The `ci.yml` file in the `.github/workflows/` directory defines the pipeline that runs on every push and pull request.\n\nThe pipeline will:\n\n- Install the necessary Ruby and Rails dependencies.\n- Set up the database for testing.\n- Run the MiniTest suite to verify the integrity of the codebase.\n\nTo view the status of the CI pipeline, refer to the build badge at the top of this `README.md` file.\n\n## Docker\n\nTo use Docker for running the app in a containerized environment:\n\n1. Build the Docker image:\n\n   ```bash\n   docker-compose build\n   ```\n\n2. Start the application with Docker:\n\n   ```bash\n   docker-compose up\n   ```\n\nThis will run the app in a container, making it available at [http://localhost:3000](http://localhost:3000).\n\nDocker ensures a consistent development and production environment, removing the need for complex system configurations.\n\n## Tailwind CSS Integration\n\nThis project uses **Tailwind CSS** for front-end styling. Tailwind CSS provides a utility-first approach to styling, making it quick and easy to build responsive UIs without writing custom CSS.\n\nIf you need to add custom styles, you can modify the `app/assets/stylesheets/application.tailwind.css` file.\n\nTo compile and watch Tailwind changes in development, use:\n\n```bash\nrails tailwindcss:watch\n```\n\n## Additional Features\n\n- **GitHub Discussions:** Engage with the project community through GitHub Discussions. [Join the discussions](https://github.com/Boutquin/Ruby-On-Rails-7-Tutorial-Hello/discussions).\n\n## Contributing\n\nContributions are welcome! To contribute, please follow these steps:\n\n1. **Fork the Repository.**\n2. **Create a New Branch:**\n\n    ```bash\n    git checkout -b feature/YourFeature\n    ```\n\n3. **Commit Your Changes:**\n\n    ```bash\n    git commit -m \"Add YourFeature\"\n    ```\n\n4. **Push to the Branch:**\n\n    ```bash\n    git push origin feature/YourFeature\n    ```\n\n5. **Open a Pull Request.**\n\nPlease ensure your code adheres to the project's coding standards and that all tests pass before submitting a pull request.\n\n## Acknowledgements\n\n- **Michael Hartl:** Special thanks to Michael Hartl for his excellent [Ruby on Rails 7 Tutorial](https://www.railstutorial.org), which provided the foundation for this project.\n\nOther resources and tools used in this project include:\n\n- [Ruby](https://www.ruby-lang.org/en/)\n- [Ruby on Rails](https://rubyonrails.org/)\n- [Tailwind CSS](https://tailwindcss.com/)\n- [Docker](https://www.docker.com/)\n- [Heroku](https://www.heroku.com/)\n- [GitHub Actions](https://github.com/features/actions)\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for more details.\n\n---\n\nDeveloped by **Pierre G. Boutquin** while working through the [Ruby on Rails 7 Tutorial](https://www.railstutorial.org) by [Michael Hartl](https://www.michaelhartl.com/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboutquin%2Fruby-on-rails-7-tutorial-hello","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fboutquin%2Fruby-on-rails-7-tutorial-hello","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fboutquin%2Fruby-on-rails-7-tutorial-hello/lists"}