HFG43 / hello_rails_and_react

Hello Rails and React

📗 Table of Contents

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

---

About

"Hello Rails & React" is an app created with Ruby on Rails to generate Random Greeting messages. A project design to practice the set up of RoR + React as one app using Webpack.

---

🛠 Built With

Tech Stack

Backend

• Ruby on Rails (v7.0.8)
• PostgreSQL

Bundler

• Webpack

Front End

• React

Linters

• Rubocop
• Stylelint

Key Features

• Generate a Rails proyect
• Use Webpack as module bundler
• Create an API endpoint that selects a random greeting message
• Install React
• Install Axios to fetch data
• Install Redux toolkit and Router
• Generate Greeting Model and Greetings Controller
• Generate Routes Api:V1 for endpoint

(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:

• A code editor (we recommend Visual Studio Code)
• Git and a GitHub account
• Ruby on Rails, you can get it here
• PostgreSQL, you can get it here

Setup

Clone this repository to your desired folder by using the command:

git clone https://github.com/HFG43/hello_rails_and_react

Install

Go to the project directory:

 cd hello_rails_and_react

Before to run the program, run the following command to install the necessary gems:

 bundle install

After installing the gems, run the following command to create and migrate the database:

 rails db:create
 rails db:migrate

Usage

Run the following command inside the project folder to start the application:

  ./bin/dev

Run linters

To verify that the ruby code is written without errors and meets good practice standards, run the following command inside the project folder:

• ruby linter:

 rubocop
 npx stylelint "**/*.{css,scss}"

(back to top)

---

👥 Author

👤 Hernán Güemes

• GitHub: @HFG43
• LinkedIn: hernanguemes

(back to top)

---

🔭 Future Features

Upcoming improvements:

• Add seeds and style

(back to top)

---

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

---

⭐️ Show your support

If you like this project and know someone who might find it helpful, please share it. Or give it a star ⭐️ if you like this project!

(back to top)

---

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)

---