Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/meryemsanem/hello-rails-back-end

Last synced: 18 days ago
JSON representation

Host: GitHub
URL: https://github.com/meryemsanem/hello-rails-back-end
Owner: meryemsanem
License: mit
Created: 2023-10-31T12:26:23.000Z (about 1 year ago)
Default Branch: dev
Last Pushed: 2023-11-23T11:01:28.000Z (about 1 year ago)
Last Synced: 2024-12-20T23:23:02.304Z (about 1 month ago)
Language: Ruby
Size: 39.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

         


  Rails API



## 📗 Table of Contents

- [📖 Rails API](#-about-project)

  - [🛠 Built With](#-built-with)

  - [🌟 Key Features](#-key-features)

  - [💻 Getting Started](#-getting-started)

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

  - [👥 Authors](#-authors)

  - [🔭 Future Features](#-future-features)

  - [🤝 Contributing](#-contributing)

  - [⭐️ Show Your Support](#️-show-your-support)

  - [🙏 Acknowledgments](#-acknowledgments)

  - [📝 License](#-license)

## 📖 Rails API 

**Rails API** is a Ruby on Rails API, serving as the backend for a full-stack web application. It offers the capability to fetch and display random greetings from a collection of messages.
**Here is the [link](https://github.com/meryemsanem/hello-react-front-end/tree/741c67326e6581e6efeecfb1ff204dc7a19d2c44) for the frontend.**

## 🛠 Built With 

### Tech Stack 

- [Ruby on Rails](https://rubyonrails.org) - A powerful web application framework.

- [PostgreSQL](https://www.postgresql.org) - An open-source relational database.

- [Bundler](https://bundler.io) - A tool for managing Ruby gem dependencies.

### Key Features 

- **Random Greetings:** The backend includes an API endpoint to retrieve random greetings from the database.

(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 the following installed:

- **Rails:** Ensure you have Ruby on Rails installed. You can find installation instructions at [Ruby on Rails](https://rubyonrails.org/).

- **PostgreSQL:** This project uses PostgreSQL as the relational database. If you don't have it, you can download it from [PostgreSQL](https://www.postgresql.org/download/).

- **Bundler:** Bundler is a tool for managing Ruby gem dependencies. Install it by running gem install bundler if you don't already have it.

### Setup

Clone this repository to your desired folder:

```bash

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

```

### Install

Install this project with:

```bash

  cd hello-rails-back-end

  bundle install

```

it will install the required gemfile for running the project

(back to top)


## 👥 Author 

👤 **Meryem Sanem Küçükbayram**

- GitHub: [Meryem Sanem Küçükbayram](https://github.com/meryemsanem)

- LinkedIn: [Meryem Sanem Küçükbayram](https://www.linkedin.com/in/meryemsanemkucukbayram/)

(back to top)


## 🔭 Future Features 

- **Styling**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/meryemsanem/hello-rails-back-end/issues).

(back to top)


## ⭐️ Show your support 

If you find this project helpful or interesting, star this repository on GitHub to let me know you like the project. ⭐️

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse.

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)