Aquinasmoriasi/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

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Budget App

This is a simple app that fetches random greetings from an integrated rails backend and displays it in the DOM using react.

🛠 Built With

• Ruby on Rails
• Postgresql
• React/Redux

Tech Stack

• Bootstrap
• Node
• React
• Redux

Server

• Localhost

Database

• PostgreSQL

Key Features

• React front-end
• Redux state management
• Integrated back-end

(back to top)

🚀 Live Demo

No live demo yet.

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

• Clone this repository by writing git clone https://github.com/Aquinasmoriasi/hello-rails-react.git
• Run bundle install to install the project's dependencies
• Run npm install to install the node dependencies
• Add your database username and password and write rails db:create to create the database
• Run rails db:migrate to migrate the tables to the created database
• Run rails db:seed to populate the tables with the
• Run rails server to open the local host

Prerequisites

In order to run this project you need:

• Install PostgreSQL in your machine
• install Ruby and Ruby on rails
• Install your preferred IDE(Visual Studio is highly recommended)
• Then run:

 bundle install

  npm install

Setup

• Clone this repository to your desired folder
• Navigate to the cloned repository and follow the aforementioned steps to get started

Install

Install this project with:

• PostgreSQL
• Ruby
• Ruby on Rails
• Webpack
• React

Usage

To run the project, execute the following command:

rails server

Run tests

To run tests, run the following command:

rspec <relative path to the test file>

Deployment

• The project has no active deployments yet

(back to top)

👥 Author

👤 Aquinas Moriasi

• GitHub: Aquinas Moriasi
• Twitter: @Aquinas747
• LinkedIn: Aquinas Moriasi

(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 support it by adding a star at https://github.com/Aquinasmoriasi/budget-app/stargazers

(back to top)

🙏 Acknowledgments

(back to top)

📝 License

This project is MIT licensed.

(back to top)