Luiscarlosvd / hello-rails-back-end

A basic rails API that works as a backend to display random greetings

Hello Rails BackEnd

📗 Table of Contents

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

📖 Hello Rails BackEnd

A basic rails API that works as a backend to display random greetings.

Link to the FrontEnd App (hello-react-front-end).

🛠 Built With

Tech Stack

List of technologies used for this project

Client

• Ruby

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Add greetings table
• Add greetings controller
• Create API endpoint for the greeting

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

• Browser (Google Chrome, Mozilla Firefox, Safari or any other browser)

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/Luiscarlosvd/hello-rails-back-end.git

Install

Install this project with:

  cd hello-rails-back-end
  bundle install

Usage

To run the project, execute the following command:

rails server -p 3001

Note: If there are any errors consider adding your necesary username and password in database.yml for setting up your local enviroment and use the following comand:

rails db:create db:migrate
rails s

Note 2: Don't forget to add messages to the greetings table to tests results. 👌

(back to top)

👥 Author

👤 Luis Valera

• GitHub: @Luiscarlosvd
• Twitter: @Luiscarlosvd29
• LinkedIn: Luis Valera

(back to top)

🔭 Future Features

• Add more API endpoints
• Add more functionality

(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 give it a ⭐️!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for giving me the opportunity to learn and grow as a developer and also I like to thank my family, they are all my support. 🌟

(back to top)

❓ FAQ

• Do I need to install any program before running this project?

  • Yes, you need to install Ruby
  
  

• Can I use this project for my own purposes?

  • Yes, you can.

(back to top)

📝 License

This project is MIT licensed.

(back to top)