jcmunav63/hello-world-rails

It's a basic Ruby on Rails app used to display a 'Hello World!' message. It sets up a PostgreSQL database connection.

Hello World Rails App

Hello World Rails App

## 📗 Table of Contents

• 📗 Table of Contents
• 📖 About project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Presentation
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 About project - Hello World Rails App

The Hello World Rails App is a basic Ruby on Rails project created to learn how to set up a Rails 7 project connected to a Postgresql database.

🛠 Built With

Tech Stack

• Ruby v 3.2.2
• Rails v 7.1.2
• PostgreSQL v 16.1.1

Key Features

• Set up a basic Ruby on Rails project.
• Connect the Rails project to a PostgreSQL database.
• Implement a controller and a view for displaying a 'Hello World' message at the main page.

(back to top)

🚀 Presentation

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Install Ruby

Set Up Rails

Prerquisites: Ruby, Ruby Development Kit (for Windows), Ruby Gems packaging system, and SQLite. Run the following command...

$ gem install rails

Setup

  cd my-folder
  git clone https://github.com/jcmunav63/hello-world-rails.git

Install

This project does not require additional dependencies, just Ruby interpreter. However, it uses RuboCop as a linter and you should set it up as well.

bundle install

Usage

To run the project, navigate to the project directory and execute the following command:

Start the Ruby on Rails web server (Puma server) typing the following command...

  rails s , or the complete command,
  rails server

Run tests

To run tests, run the following command:

Run the following command

rubocop

Deployment

You can deploy this project using:

Not available at the moment.

(back to top)

👥 Authors

👤 Juan Carlos Muñoz

• GitHub: @jcmunav63
• Twitter: @jcmunav63
• LinkedIn: @juan-carlos-muñoz

(back to top)

🔭 Future Features

• No future features will be added.

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

(back to top)

⭐️ Show your support

If you like this project please give a star. Thanks in advance.

(back to top)

🙏 Acknowledgments

I would like to thank all of my colleagues who inspire to do my best everyday.

(back to top)

❓ FAQ

Did you create this project from scratch?

• Yes, it is a basic project for starting to set up a Ruby on Rails project, connecting it to a external PostgreSQL database, and start to implement a custom controller and its view.

(back to top)

📝 License

This project is MIT licensed.

(back to top)