RaphDasilva/hello-rails-react

Hello Rails React

📗 Table of Contents

• 📗 Table of Contents
• 📖 Hello Rails React
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • 📝 License

📖 Hello Rails React

Hello Rails React is a project that demonstrates how to build a Rails API with a React frontend.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby On Rails

Database

• PostgreSQL

Key Features

• Render Random messages
• Rails API stores database
• Webpack combiles JavaScript

(back to top)

🚀 Live Demo

• Not Availabe

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

  ruby 3.2.1
  rails
  node
  yarn

Setup

Clone this repository to your desired folder:

Example commands:

  cd your-folder
  git clone https://github.com/iamchristianani/hello-rails-react.git

Install

Install this project with:

Example command:

  cd my-project
  bundle install

Usage

To run the project, execute the following command:

Example command:

  ./bin/dev or rails server

Run tests

To run tests, run the following command:

Example command:

  bin/rails rspec

(back to top)

👥 Authors

👤👤 Raphael Okolo

• GitHub: @RaphOkolo
• Twitter: @RaphOkolo
• LinkedIn: @RaphOkolo

(back to top)

🔭 Future Features

• Add more greetings
• Add styles
• Add Header

(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 please give it a ⭐️. Your support is greatly appreciated!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me this chance to learn how to build a Rails API with a React frontend.

(back to top)

📝 License

This project is MIT licensed.

(back to top)