Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/stephenkati/hello-rails-backend

Hello rails backend is an api that generates random greetings.
https://github.com/stephenkati/hello-rails-backend

api postgresql ruby-on-rails

Last synced: 23 days ago
JSON representation

Hello rails backend is an api that generates random greetings.

Host: GitHub
URL: https://github.com/stephenkati/hello-rails-backend
Owner: stephenkati
License: mit
Created: 2023-07-13T12:52:22.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-08-14T06:30:30.000Z (over 1 year ago)
Last Synced: 2024-10-04T00:42:25.827Z (about 1 month ago)
Topics: api, postgresql, ruby-on-rails
Language: Ruby
Homepage:
Size: 33.2 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Hello rails backend



# 📗 Table of Contents

- [📖 About the Project](#about-project)

- [Front-End](#frond-end)

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 [Hello rails backend] 

**[Hello rails backend]** is an api that generates random greetings.

## Front-End 

- The api is consumed by this [React project](https://github.com/stephenkati/hello-react-front-end/)

## 🛠 Built With 

### Tech Stack 

  Ruby on Rails

  


    https://rubyonrails.org/

  

  Postgres

  

    https://www.postgresql.org/

  


### Key Features 

- **[Generate random greetings]**

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

- Install Ruby

- Install Rails

- Install Postgresql

### Setup

Clone this repository to your desired folder:

```

  cd hello-rails-backend

  git clone https://github.com/stephenkati/hello-rails-backend.git

```

### Install

Install this project with:

```

  cd hello-rails-backend

  bundle install && npm install

```

### Usage

To run the project, execute the following command:

```

  yarn build

```

```

  rails s

```

### Run tests

To run tests, run the following command:

```

  rubocop --color

```

```

  rspec

```

(back to top)


## 👥 Authors 

👤 **Author1**

 *[Stephen Katuli]*

 

- GitHub: [@githubhandle](https://github.com/stephenkati)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/stephen-katuli/)

(back to top)


## 🔭 Future Features 

- [ ] **[Greetings for multiple languages]**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

If you like this project please show support by staring ⭐️.

(back to top)


## 🙏 Acknowledgments 

* I am grateful for microverse for the opprtunity to enroll in their curriculum.

(back to top)


## 📝 License 

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

(back to top)