Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Last synced: 4 days ago
JSON representation

Host: GitHub
URL: https://github.com/mattgomb/hello-rails-back-end
Owner: MattGomb
License: other
Created: 2023-03-07T16:16:49.000Z (almost 2 years ago)
Default Branch: development
Last Pushed: 2023-03-08T02:37:33.000Z (almost 2 years ago)
Last Synced: 2024-11-06T06:43:12.541Z (about 2 months ago)
Language: Ruby
Size: 45.9 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

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

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 Hello-rails-back-end 

This project is the back-end half of experimenting with React/Rails in two separate repos.

You can find the React-half [HERE](https://github.com/MattGomb/hello-react-front-end/pull/1)

## 🛠 Built With 

### Tech Stack 

  Server

  


    Rails

  


Database

  


    PostgreSQL

  


### Key Features 

- **[Random greeting/saying generation on api endpoint]**

(back to top)


## 🚀 Live Demo 

- There is no live demo of this project

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

- Rails

- PostgreSQL

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone [email protected]:MattGomb/hello-rails-back-end.git

```

### Install

Install this project with:

```

bundle install

```

```

npm install

```

or

```

yarn install

```

### Usage

TThis app uses PostgreSQL databases for data preservation. Please provide valid credentials in a `.env` file and place it in the root folder.



To initialize the database run:


```

rails db:create

```

```

rails db:migrate

```

There are a couple of prepared messages, if you don't want to add them through the console:

```

rails db:seed

```

To run the server, execute the following command:

```

rails s` or `rails server

```

this will start the server on http://localhost:3000/

### Run tests

N/A

### Deployment

N/A

(back to top)


## 👥 Authors 

👤 **Mátyás Gombos**

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

- Twitter: [@MtysGombos1](https://twitter.com/MtysGombos1)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/gombos-matyas/)

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](../../issues/).

(back to top)


## ⭐️ Show your support 

If you like this project please consider giving it a star!

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for the opportunity

(back to top)


## 📝 License 

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

(back to top)