XsidX/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 React Rails

Hello React Rails is a hello world project I used to practice integrating rails with react and redux.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

Some features of the application.

• Rails api
• React view
• Redux data management

(back to top)

(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 runtime environment
• Postgresql
• Rails
• React.js
• Redux

Setup

Clone this repository to your desired folder:

Install

Install this project with:

• Clone the repository using git@github.com:XsidX/hello-rails-react.git
• Navigate to the folder using cd hello-rails-react
• Use the following commands to
  • install necessary gems bundle install
  • run the development server ./bin/dev

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

👤 Sidney

• GitHub: XsidX
• Twitter: @_sid_o
• LinkedIn: Sidney Kaguli

(back to top)

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

I would like to thank microverse for providing the curriculum to guide me on this project.

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