Hello Rails

📗 Table of Contents

• 📗 Table of Contents
• Hello Rails
  • 🛠 Built With
    • Tech Stack
  • Key Features
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • Acknowledgments
  • ❓ FAQ
  • 📝 License

Hello Rails

Hello Rails is a simple backend api that provides random greetings. It is built using Ruby on Rails and Postgres database.

🛠 Built With

Tech Stack

Server

• Ruby

back to top

Key Features

Key Features of Project.

• Backend Api to provide random greetings
• Postgres database to store greetings

💻 Getting Started

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

Prerequisites

In order to run this project you need:

• Ruby
• Rails
• Postgresql

Setup

Clone this repository to your desired folder:

  cd your_desired_folder
  git clone https://github.com/MohamedHNoor/hellorails.git

Install

Install this project with:

• After cloning type 'cd hellorails'.
• Run 'bundle install' to install all the required dependencies.

Usage

To run the project, execute the following command:

• Run 'rails db:create' to create a new database
• Run 'rails db:migrate' to migrate the db and build the schema
• Run 'rails s' to start the server

back to top

👥 Authors

👤 Mohamed Hassan Noor

• GitHub: @MohamedHNoor
• Twitter: @MohamedHNoor
• LinkedIn: @MohamedHNoor

back to top

🔭 Future Features

• [ Personalize greetings ]

🤝 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
• etc

❓ FAQ

• Do I have to have any previous knowledge about ruby to use this project?

  • No!

• How to use this project?

  • check the Getting Started section to have a complete guid on how to setup and run teh project.

back to top

📝 License

This project is MIT licensed.

back to top