SabaAhmad404/hello-rails-back-end

Hello Rails React

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 Hello Rails React

Hello Rails React is a sample Rails application that integrates React for frontend development. It demonstrates how to set up a Rails app with React, use react-router for routing, connect to a Rails API endpoint, and display data in a React component.

Click Hereto take you to the frontend pull request.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Integration of React with Ruby on Rails
• React Router for frontend routing
• API endpoint for random greetings

(back to top)

🚀 Live Demo

• Live Demo Link

(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 to have the following installed:

• Ruby (version 3.2.1)
• Node.js (version 18.16.0)
• Yarn (optional but recommended)
• PostgreSQL

Setup

Clone this repository to your desired folder:

git clone https://github.com/SabaAhmad404/hello-rails-back-end.git
cd hello-rails-react-ui

Install

Install the required Ruby gems:

bundle install

Install the required Node.js packages:

yarn install

Usage

Start the

Rails server:

rails server

Open your browser and visit http://localhost:3000 to see the application running.

Run tests

To run the tests, execute the following command:

bundle exec rspec

Deployment

This project can be deployed using your preferred hosting platform or service. Follow the deployment instructions provided by the platform of your choice.

(back to top)

👥 Authors

👤 Saba Ahmad

• GitHub: @SabaAhmad404
• LinkedIn: Saba Ahmad

(back to top)

🔭 Future Features

• Feature 1: Add user authentication
• Feature 2: Implement a user profile page
• Feature 3: Allow users to create and manage their own greetings

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page for any open issues or to create a new one.

(back to top)

⭐️ Show your support

If you find this project helpful or you like it, please consider starring it and showing your support by sharing it with others.

(back to top)

🙏 Acknowledgements

Special thanks to the Microverse community and the open-source contributors for their valuable contributions.

(back to top)

📝 License

This project is MIT licensed.

(back to top)