benshidanny11/hello-rails-back-end-1

Microverse README Template

📗 Table of Contents

• 📗 Table of Contents
• 📖 [Rails Backend]
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
      • 1. Navigate to the location of the folder in your machine:
      • 2. Install the gems:
      • 3. Set up the database with your credentials:
      • 4. Create the databases:
      • 5. Migrate the databases:
      • 6. Seed the dummy data:
    • Usage
      • 7. Run the server:
    • Run tests
  • 👥 Authors
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 [Rails Backend]

[Hello Rails Backend] is a Rails Backend application whose front-end is implemented using React here.

🛠 Built With

Tech Stack

Client

• React.js

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Rails API

(back to top)

🚀 Live Demo

• Live Demo Link

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

 gem install rails

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/rex-9/Hello-React-on-Rails.git

Install

1. Navigate to the location of the folder in your machine:

you@your-Pc-name:~$ cd <transactions-on-rails>

2. Install the gems:

bundle install

3. Set up the database with your credentials:

• setup the database environment in

config/database.yml

4. Create the databases:

rails db:create

5. Migrate the databases:

rails db:migrate

6. Seed the dummy data:

rails db:seed

Usage

To run the project, execute the following command:

7. Run the server:

rails server

Run tests

To run tests, run the following command:

Example command:

  bin/rails rspec spec

(back to top)

👥 Authors

👤 Rex

• Github: @rex-9
• Medium: @rex9
• LinkedIn: @rex9
• Facebook: @htetnaing0814
• Angelist: @rex9

(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, please kindly offer me opportunities for further contributions.

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving the inspiration to build this project.

(back to top)

❓ FAQ

• Can I build and use this project on Windows

  • Yes, you can. Check my commit history. If it's hard to understand, you can easily reach out to me.

(back to top)

📝 License

This project is MIT licensed.

(back to top)