Ol-create / hello_rails_react_backend

Hello Rails - BackEnd Service

📗 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 - Backend

This project is intended to set-up and initialize a RoR project as a backend service along other serviecs such as React for the frontend

Hello Rails - Backend is the initializing base blueprint project for building apps using RoR as the backend service

🛠 Built With

Tech Stack

This App backend template was built with Ruby on Rails, using Gitflow and customized Linters

Client

• Ruby

Server

• Rails

Database

• PostgreSQL

Frontend

• React Frontend Repository

Key Features

• RoR for building integrated apps
• PostgreSQL as the database manager

(back to top)

💻 Getting Started

Prerequisites

Check your Ruby version or install it

ruby --version && irb

The ouput should start with something like ruby 3.1.2

If not, install the right ruby version using rbenv (it could take a while):

rbenv install 3.1.2

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

Clone the repository

git clone https://github.com/Ol-create/hello_rails_react_backend.git
cd hello-rails-back-end

Install

• Ensure you have PostgreSQL installed before running the application psql --version
• Run bundle install
• Create a .env file in the project's root folder to assign variable values for the psql database (linked to the config/database.yml)
• Run rails db:create and then rails db:migrate
• Run rails server
• Open Browser http://localhost:3000/

.env File Structure

See the .env.example file

Replacing the variable values where needed (most importantly username and password)

Usage

To run the project, execute the following command:

  rails server

Testing

To test and utilize the code, use the terminal and run ruby by inputting irb in the command line, or by using an extension in Visual Studio Code like Code runner

The user then can modify and play with the files as needed

(back to top)

👥 Author

👤 Oluyemi Paul

• GitHub: Ol-create
• Twitter: OluyemiPaul99
• LinkedIn: paul-oluyemi-193966ab

(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

• Hat tip to anyone whose code was used
• Inspiration
• To all the collaborators for the Readme Template
• The Microverse Team

(back to top)

📝 License

This project is MIT licensed.

(back to top)