Hannziegel/hello-rails-react

Microverse README Template

📗 Table of Contents

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

📖 [Hello Rails React]

Hello Rails React is a simple web app that combines functionalities of Ruby on Rails and React. It allows users to get a random greeting from the backend API.

🛠 Built With

Tech Stack

Describe the tech stack and include only the relevant sections that apply to your project.

Client

• React.js
• Redux Toolkit

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

It allows a user to get random greeting

(back to top)

🚀 Live Demo

Coming soon.

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

• Ruby development environment
• Rails
• Node
• npm or yarn

Setup

Clone this repository to your desired folder:

Install

Install this project with:

Usage

To run the project, execute the following command:

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Author

Mention all of the collaborators of this project.

👤 Rodrigo Johann Reckziegel Nunes

• GitHub: @Hannziegel
• LinkedIn: @Rodrigo

(back to top)

🔭 Future Features

It will allow users to record their greeting.

(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 you can give me a star.

(back to top)

🙏 Acknowledgments

I would like to thank the Microverse curriculum.

(back to top)

❓ FAQ

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)