fmanimashaun / hello-rails-react

This is a simple Rails and React application that displays a random greeting message.

Hello Rails React

📗 Table of Contents

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

📖 Hello Rails React

This is a simple Rails and React application that displays a random greeting message using redux-toolkit and react-router.

🛠 Built With

Programming Language

• Ruby 3.2.2
• JavaScript

Web Application Framework

• Rails 7.1.3

Database

• PostgreSQL (pg gem)

Web Server

• Puma

JavaScript Modules

• Webpack (jsbundling-rails gem, webpack and webpack-cli in package.json)

UI Library

• React (react and react-dom in package.json)

Hotwire

• Turbo (turbo-rails gem, @hotwired/turbo-rails in package.json)
• Stimulus (@hotwired/stimulus in package.json)

APIs

• Jbuilder

Performance Optimization

• Bootsnap

Testing

• Debug
• Capybara
• Selenium Webdriver

Development Tools

• Web Console (web-console gem)
• Babel (@babel/core, @babel/preset-env, @babel/preset-react, babel-loader in package.json)

Key Feature

• Random Greeting: Displays a random greeting message from a selection of 5 different greetings stored in the database.
• React Components: Uses React to create dynamic UI components.
• API Endpoint: Includes an API endpoint that selects a random greeting from the database.
• Redux Store: A store, an action, and a reducer are created that connect to the API endpoint to get the random greeting.

👆

💻 Getting Started

To get started with the project, follow the steps below.

Prerequisites

To run this project, ensure you have the following installed:

• Git
• Ruby
• rails
• A code editor (e.g., VsCode)

Setup

Clone the repository to your local machine:

git clone https://github.com/fmanimashaun/hello-rails-react.git

cd hello-rails-react

bundle install

yarn install

Database Setup

This application uses PostgreSQL as the database. Here are the steps to set it up:

1. Ensure PostgreSQL is installed on your machine and running.

2. Update the config/database.yml file with your PostgreSQL username and password in the default section.

3. Create the database:

rails db:create

4. Run migrations to set up the database schema:

rails db:migrate

5. Load sample data into database:

rails db:seed

Usage

To run the program, you can use a Ruby interpreter. For example, to interact with the code, use the following:

1. Start the server

bin/dev

2. Access the Blog app in your web browser at http://localhost:3000.

👆

👥 Authors

👤 Fisayo Michael Animashaun

• GitHub: @fmanimashaun
• Twitter: @fmanimashaun
• LinkedIn: Fisayo Michael Animashaun

👆

🔭 Future Features

• Add more functionality...

👆

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Issue Page

👆

⭐️ Show your support

If you like this project leave a start for it.

👆

🙏 Acknowledgments

• I'd like to thank Microverse for helping us in the journey to become a Fullstack developer.

👆

📝 License

This project is MIT licensed.

👆