ginabeki/hello-rails-back-end

📗 Table of Contents

📗 Table of Contents

• 📖 hello-rails-back-end
• 🛠 Built With
• 💻 Getting Started
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgments
• 📝 License

📖 Hello-rails-back-end

Hello-rails-back-end is the rails backend API application for implementing a connection between a Ruby on Rails back-end and React front-end.

🛠 Built With

Tech Stack

Server

• Ruby
• Rails

Database

• PostgreSQL

Key Features

• Handles logic for storing and retrieving data from the database
• Handles logic for returning data to the frontend

(back to top)

🎨 Link to Frontend

• Frontend

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

 git
 bundle
 Your favorite text editor

Setup

Clone this repository to your desired folder:

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

Database setup

Connect to your local postgres database:

Install

Install this project with:

  cd hello-rails-back-end
  bundle install
  rails: db:create - create the database
  rails: db:migrate - run pending migrations for the current environment.

Usage

To run the project, execute the following command:

  rails server - Starts the development server
  rails console - Starts the interactive command line

Run tests

To run tests, run the following command:

  rspec - Runs the test suite

(back to top)

👥 Author

👤 Gina Beki

• GitHub: @ginabeki
• LinkedIn: Gina Beki

(back to top)

🔭 Future Features

• Add more endpoints

(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 leave a star🤩

(back to top)

🙏 Acknowledgments

• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)