Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Last synced: 24 days ago
JSON representation

Host: GitHub
URL: https://github.com/newhoteng/hello-rails-back-end
Owner: newhoteng
License: mit
Created: 2023-08-15T11:30:47.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-08-15T16:23:06.000Z (over 1 year ago)
Last Synced: 2024-10-23T19:24:08.213Z (2 months ago)
Language: Ruby
Size: 26.4 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)

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

  - [Prerequisites](#prerequisites)

  - [Setup](#setup)

  - [Install](#install)

  - [Database](#database)

  - [Usage](#usage)

- [👥 Authors](#authors)

- [🤝 Contributing](#contributing)

- [⭐ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

#  :open_book: hello-rails-react 

hello-rails-backend is project to practice setting up a Rails/React project as two apps. This repository is the backend app

- [Link to frontend app](https://github.com/newhoteng/hello-react-front-end/tree/frontend)

## :hammer_and_wrench: Built With 

### Tech Stack

Backend



  Rails



Database

  


    PostgreSQL

  


### Key Features

  - Api end point

(back to top)


## :computer: Getting Started 

To get a local copy up and running, follow these steps.


### Prerequisites

You need the following tools be installed in your computer:

- [Rails](https://guides.rubyonrails.org/)

- [Git](https://www.linode.com/docs/guides/how-to-install-git-on-linux-mac-and-windows/)

- [Ruby](https://github.com/microverseinc/curriculum-ruby/blob/main/simple-ruby/articles/ruby_installation_instructions.md)

- IDE

### Setup

Clone this repository to your desired folder:


```sh

  cd my-prefered-folder

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

```

### Install

Install this project with:


```sh

  cd hello-rails-back-end

  bundle install

  npm install

```

### Database

Create the databases and run migrations with:

```sh

rails db:create

rails db:migrate

```

### Usage

To run the project, execute the following command:

```sh

  rails server or rails s

```

(back to top)


## :busts_in_silhouette: Authors 

:bust_in_silhouette: **Harriet Oteng**

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

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

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/harriet-oteng/)

(back to top)


## :handshake: Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## :star: Show your support 

If you like this project give it a star.

(back to top)


## :pray: Acknowledgements 

- 

(back to top)

  

## :memo: License 

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

(back to top)