Ruthmy / hello-react-front-end

Hello Rails - Frontend

📗 Table of Contents

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

---

Hello Rails - Frontend

"Hello Rails - Frontend" is a small project to practice the basics of Ruby on Rails as an API to be consumed by a React/Redux Toolkit application.

Two repositories were created for its construction:

• A backend repository with an API built with the Ruby on Rails Framework with a PostgreSQL database.
• A frontend repository with a React/Redux Toolkit application from which the created API is consumed.

---

🛠 Built With

Tech Stack

The project is built using the following technologies:

Client

• HTML

• CSS3

• JavaScript

• React

• Redux

---

Key Features

• HTML & CSS3
• JavaScript
• Linters
  • StyleLint
  • ESLint
• React
• Redux
• Follow Microverse's list of best practices

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

• A modern browser (supports html5)

• Git and a GitHub account

Setup

Clone this repository to your desired folder by using this 👇️ command :

git clone https://github.com/Ruthmy/hello-react-front-end

Install

Install this project with:

 npm install

Usage

 npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

Deployment

• Not aplicable.

(back to top)

---

👥 Authors

👤 Ruth Abreu

• GitHub: @Ruthmy
• Twitter: @rury_exe
• LinkedIn: LinkedIn

(back to top)

---

🔭 Future Features

Upcoming improvements:

• Accessibility improvements.

(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 and know someone who might find it helpful, please share it. Or give it a star ⭐️

(back to top)

---

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)

---