yonas44/hello-rails-back-end

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
• 👥 Authors
• 🔭 Future Features
• ⭐️ Show your support
• 📝 License

📖 Hello_rails_back-end

A rails app that allows users to fetch a random message sent from the database.

• You can find the front-end app of this project using this link

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• User can fetch a random greeting message sent from the backend.

(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 installed in your machine, you can user this link to install in your OS.
• PostgreSQL is installed in your machine, you can refer this link to install in your machine. Then run:

Setup

Clone this repository to your desired folder:

  git clone https://github.com/yonas44/hello-rails-back-end.git

  cd hello-rails-back-end

Install

Run these commands to install the required dependencies:

  bundle install

  npm install

Usage

To run the project, execute the following command:

  rails s

• To access the api documentation, simply run: http://{localhost}/api-docs/index.html.

• localhost is the host where your server is running, and also make sure to specify the port

• Here is an example:

http://127.0.0.1:8080/api-docs/index.html

👥 Author

• GitHub: @yonas44
• LinkedIn: Yonas Tesfu

(back to top)

🔭 Future Features

• Add testing for my project.

🤝 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...

(back to top)

📝 License

This project is MIT licensed.

(back to top)