📗 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
• 📝 License

📖 Hello React Rails

Hello React Rails is a project is meant for setting up a "Hello world" Rails project as one app with Webpack and React. It is meant to be a starting point for a Rails project with React.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Rails

Database

• PostgreSQL

Key Features

• [Random Greeting message]
• [Single Fullstack web app]

(back to top)

🚀 Live Demo

• [Live Demo Link] 😃 not yet available

(back to top)

💻 Getting Started

Prerequisites

In order to run this project you need followed installed on your computer:

• Ruby v3+,
• Rails v7+
• PostgreSQL
• An IDE e.g Visual studio code.
• A terminal.

Setup

Clone this repository to your desired folder or download the Zip folder:

git clone https://github.com/devMunyi/hello_rails_app

• Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd hello_rails_app

Installations

Install dependencies to this project with:

  bundle install

  npm install

Setup Database (Mandatory)

• Create .env file and add the following three lines(be sure to replace with your details):

POSTGRES_HOST='localhost'
POSTGRES_USERNAME='your_postgress_username'
POSTGRES_PASSWORD='your_postgress_password'

-To create database run:

rails db:create

If you have made a migration then run this command

rails db:migrate

rails db:seed

Usage

To run the project, execute the following command:

  ./bin/dev  # for building css, and webpack, and rails server

Or

  rails server or rails s  # after build

(back to top)

👥 Authors

👤 Samuel Munyi

• GitHub: @devMunyi
• LinkedIn: Samuel Munyi
• Twitter: @munyi_sam

🔭 Future Features

• [Add Loading Icon awaiting api call to send response]
• [Add more features on UI including styling]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank:

• Microverse
• Code Reviewers

(back to top)

📝 License

This project is MIT licensed.

(back to top)