Hello Rails - Backend

📗 Table of Contents

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

---

Hello Rails - Backend

"Hello Rails - Backend" is a small project to practice the basics of Ruby on Rails as an API to be consumed by a React/Redux Toolkit application.

Two repositories were created for its construction:

• A backend repository with an API built with the Ruby on Rails Framework with a PostgreSQL database.
• A frontend repository with a React/Redux Toolkit application from which the created API is consumed.

---

🛠 Built With

Tech Stack

The project is built using the following technologies:

• Ruby on Rails.
• PostgreSQL.
• Rubocop.

---

Key Features

• Ruby on Rails
• Linters
  • Rubocop
• Follow Microverse's list of best practices

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

• Installed Ruby and Ruby on Rails.
• If you're using Windows, have installed WSL.
• If you're using MacOS, an option is using UTM.

Setup

To clone this repository to your desired folder, run the following command:

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

Navigate to the cloned repository and run the following command to install the necessary gems:

cd hello-rails-back-end
bundle install

Before continue you will need to create your own credentials file. To do so, first remove config/master.key and config/credentials.yml.enc if they exist.

run the following command:

EDITOR=code rails credentials:edit 

You can close the editor that opens. This command will create a new master.key and credentials.yml.enc if they do not exist. Now you can continue.

Usage

Initialize it with

rails server

Then open http://localhost:4000 in your browser.

Now you need to create the database, run the following command:

rails db:create

Then migrate the database:

rails db:migrate

And finally, seed the database:

rails db:seed

Test

To run the tests try the following command:

rspec spec

(back to top)

---

👥 Authors

👤 Ruth Abreu

• GitHub: @Ruthmy
• Twitter: @rury_exe
• LinkedIn: LinkedIn

(back to top)

---

🔭 Future Features

Upcoming improvements:

• Accessibility improvements.

(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 and know someone who might find it helpful, please share it. Or give it a star ⭐️

(back to top)

---

🙏 Acknowledgments

I thank Microverse for this fantastic opportunity, and the code reviewers for their advice and time.

(back to top)

---

📝 License

This project is MIT licensed.

(back to top)

---