Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/lucas-erkana/hello-rails-back-end

Hello Rails Back-end is an tutorial for creating a Rails API with React Front-end. This project is a part of the Microverse curriculum. The goal is to create a Rails API and React Front-end that will display a random greeting from the database.
https://github.com/lucas-erkana/hello-rails-back-end

ruby-on-rails

Last synced: about 1 month ago
JSON representation

Hello Rails Back-end is an tutorial for creating a Rails API with React Front-end. This project is a part of the Microverse curriculum. The goal is to create a Rails API and React Front-end that will display a random greeting from the database.

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)
- [👥 Authors](#-authors)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Hello Rails Backend

Hello Rails Back-end is an tutorial for creating a Rails API with React Front-end. This project is a part of the Microverse curriculum. The goal is to create a Rails API and React Front-end that will display a random greeting from the database.

## 🛠 Built With
This app is build with Ruby on Rails and Postgresql.
### Tech Stack
>

  • Ruby

  • >
  • Ruby on Rails

  • >
  • Postgresql
  • ### Key Features

    > - User can create a See a random Greeting

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

    - Mac or PC
    - Install Ruby
    - Install Rails
    - Install Postgresql
    - Understanding of Ruby

    ### Frontend

    Here is the [Front-End](https://github.com/Lucash2022/hello-react-front-end) of this app.

    ### Setup

    - Clone this repository to your desired folder:

    ```sh
    git clone https://github.com/Lucash2022/hello-rails-back-end.git
    ```

    - Navigate into the cloned folder

    ```sh
    cd hello-rails-back-end
    ```
    ### Install

    - Install this project with:

    ```sh
    bundle install
    yarn install
    ```

    - Set up the database
    Change the username and password of your postgres account in `config/database.yml`

    ```sh
    rails db:create db:migrate db:seed
    ```

    - Start the server

    ```sh
    rails server
    ```

    (back to top)

    ## 👥 Authors

    👤 **Lucas Erkana**

    - GitHub: [@Lucash2022](https://github.com/Lucash2022)
    - Twitter: [@Lucas_David_22](https://twitter.com/@Lucas_David_22)
    - LinkedIn: [Lucas Erkana](https://www.linkedin.com/in/lucas-erkana/)
    - Frontend Mentor - [@PLucash2022](https://www.frontendmentor.io/profile/Lucash2022)

    (back to top)

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

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

    (back to top)

    ## ⭐️ Show your support

    If you like this project, please leave a ⭐️

    (back to top)

    ## 🙏 Acknowledgments
    - I would like to thank Microverse for providing us with reading materials that aided us to during the project development

    (back to top)

    ## 📝 License

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

    (back to top)