Rails React Recipes

📗 Table of Contents

• 📖 About the Project
• 🛠 Build With
  • Tech Stack
  • Key Features
• 📖 Getting Started
  • 🛠 Setup
  • Prerequisites
  • Usage
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgment
• 📜 License

📖 About the Project

This is a simple recipes app with a basic CRUD and Rails API, created to demonstrate how to connect a Ruby on Rails back-end with a React front-end using ESbuild. This project helps you achieve the following learning objectives:

• Implement a connection between a Ruby on Rails back-end and a React front-end.
• Understand the pros and cons of different approaches for connecting Ruby on Rails with React.
• Understand how to use Webpack to bundle a React front-end with a Ruby on Rails back-end.

🛠 Built With

• Ruby on Rails
• React
• ESbuild
• PostgreSQL

Key Features

• Ruby on Rails and React Integration
• ESbuild Configuration
• React Components
• Rails recipes from internal API

💻 Getting Started

🛠 Setup

1. Clone the Project Repository:

   git clone [email protected]:sergio-usma/rails_react_recipe.git

2. Navigate to the Project Folder:

   cd rails_react_recipe

Prerequisites

Before you can run the app, ensure you have the following prerequisites and configurations in place:

• Ruby: Verify that Ruby is installed on your machine by running ruby -v in your terminal. If not, download and install Ruby from the official Ruby website.

• Ruby on Rails: Install the Ruby on Rails framework using the following command if you haven't already:

  gem install rails

• Code Editor: Use a code editor like Visual Studio Code (VSCode). If you don't have it, download it from the official website.

• Git: Make sure Git is installed and configured for version control. Download Git from the official Git website.

• PostgreSQL: Install and properly configure PostgreSQL on your development server. We assumes the use of PostgreSQL as the default database. Download PostgreSQL from the official PostgreSQL website.

• Ruby on Rails Configuration: Configure your Ruby on Rails project to use PostgreSQL as the default database.

With these prerequisites and configurations in place, you're ready to set up and run the app.

📖 Usage

Follow these steps to use the app:

1. Open your Terminal:

   Navigate to the directory where the project files are located:

   cd /path/to/your/project/files

2. Start the server script running the command:

   ./bin/dev

3. Open your browser and go to:

    http://localhost:3000/

👥 Authors

👤 Sergio Usma

• GitHub: @sergio-usma
• Twitter: @VonUsma
• LinkedIn: Sergio Andres Usma

🔭 Future Features

• Add images for recipes
• API endpoint working

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page and contribute to the project.

⭐️ Show your support

If you like this project, please consider supporting us! Your support helps us to continue developing and improving our project for everyone to enjoy. Whether it's a small donation, sharing the project with your friends, or contributing your skills and expertise, every little bit makes a huge difference. With your support, we can create something truly amazing together. Thank you for being a part of our community and helping us to make a difference!

🙏 Acknowledgment

I would like to express my heartfelt gratitude to Microverse for providing us with the opportunity to work on this project. I also recognize the good job of Chuks Opia for writing the article 'How To Set Up a Ruby on Rails v7 Project with a React Frontend on Ubuntu 20.04' Published on November 4, 2022, at DigitalOcean

📜 License

This project is licensed under the MIT License.