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

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

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/cancelei/hello-rails-back-end
• Owner: cancelei
• License: other
• Created: 2023-11-08T20:44:16.000Z (about 1 year ago)
• Default Branch: dev
• Last Pushed: 2023-11-20T17:06:31.000Z (12 months ago)
• Last Synced: 2024-05-17T15:54:23.549Z (6 months ago)
• Language: Ruby
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  
Hello Rails Back-end



# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)

- [📖 Hello Rails Back-end ](#Hello Rails Back-end)

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

    - [Tech Stack ](#tech-stack-)

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

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

    - [Prerequisites](#prerequisites)

    - [Setup](#setup)

    - [Install](#install)

    - [Usage](#usage)

    - [Run tests](#run-tests)

    - [Deployment](#deployment)

  - [👥 Authors ](#-authors-)

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

  - [🤝 Contributing ](#-contributing-)

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

  - [🙏 Acknowledgments ](#-acknowledgments-)

  - [❓ FAQ (OPTIONAL) ](#-faq-optional-)

  - [📝 License ](#-license-)

# 📖 React+Rails One Repo App 

**Hello Rails Back-end** is an exercise with 2 repos, but features a random generated greeting message.

Here is the link to the Front-End in React 

## 🛠 Built With 

### Tech Stack 

  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


Front-End

  


    
React

  


### Key Features 

- **Setup a Dual Repo APP, using RubyRails Back-end and a React Front-end.**

- **Rails 7.1.1 (lastest)+ Postgres**

- **Latest React using (create-react-app command)**

(back to top)


## 💻 Getting Started 

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

Note: We are assuming you have pre-installed ruby, WSL, ubuntu and rails!

### Prerequisites

In order to run this project you need:

first at all, install rails:

```sh

gem install rails -v 7.1.1

```

### Setup

Clone both repositories to your desired folder:

```sh

  cd your-folder

  [email protected]:cancelei/hello-rails-backend.git

```

### Install

Install this project with:

```sh

  cd hello-rails-backend

  bundle install

```

Setting up the Data Base:

```sh

  "Set up Username and password information in the config/database.yml"

  rails db:create

  rails db:migrate

  rails db:seed

```

### Usage

To run the project, execute the following command:

```sh

  rails s (on port 3000, remember to use port 3001 for front-end)

```

### Deployment

The deployment will be available soon !

(back to top)


## 👥 Authors 

👤 **Glauber Bannwart**

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

- LinkedIn: [Glauber Bannwart](https://www.linkedin.com/in/gbannwart/)

  

(back to top)


## 🔭 Future Features 

> We this project can improve, we are planning to include the next features soon:

- [X] **User Interface, Controllers and Models**

- [N/A] **API documentation**

- [X] **View Implementation**

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

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

(back to top)


## ⭐️ Show your support 

> Would you like to help?

If you like this project feel free to leave an start, as well if you have a suggestion feel free to visit issues page.

(back to top)


## 🙏 Acknowledgments 

I would like to thank Microverse for creating this exercise-project.

(back to top)


## ❓ FAQ (OPTIONAL) 

> Learn more about FAQ below:

- **How do I fix Linters errors if I modify the project?**

  - for rubocop run

  ```sh

  rubocop -A

  ```

  - for Stylint run:

  ```sh

  npx stylelint "**/*.{css,scss}" --fix

  ```

(back to top)


## 📝 License 

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

(back to top)