Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

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

Hello Rails back-End is a Hello world project to learn about rails & react in two apps.
https://github.com/ansaribrahim/hello-rails-back-end

api rails ruby

Last synced: 26 days ago
JSON representation

Hello Rails back-End is a Hello world project to learn about rails & react in two apps.

Awesome Lists containing this project

README

        



# Hello-Rails-Back-End

## 📗 Table of Contents

- [📖 Budget app ](#-blog-app-)
- [🛠 Built With ](#-built-with-)
- [Tech Stack ](#tech-stack-)
- [Key Features ](#key-features-)
- [🚀 Front-End-Link ](#-front-end-link-)
- [💻 Getting Started ](#-getting-started-)
- [Prerequisites](#prerequisites)
- [Setup](#setup)
- [Install](#install)
- [Usage](#usage)
- [👥 Author ](#-author-)
- [🔭 Future Features ](#-future-features-)
- [🤝 Contributing ](#-contributing-)
- [⭐️ Show your support ](#️-show-your-support-)
- [🙏 Acknowledgments ](#-acknowledgments-)
- [📝 License ](#-license-)

# 📖 Hello-Rails-Back-End

**Hello-Rails-Back-End** is a Hello world project to learn about rails & react in two apps.

## 🛠 Built With

### Tech Stack

Server

  • React

  • Rails
  • Database

  • Postgres
  • ### Key Features

    - Shows a random Greeting to the user with API Links

    (back to top)

    ## 🚀 Front End Link

    - [Front-End-link](https://github.com/AnsarIbrahim/hello-react-front-end)

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

    ```
    ruby >= 3.2.0
    react > 16.3.2
    rails >= 7.0
    postgres >- 15.3
    ```

    ### Setup

    Clone this repository to your desired folder:

    ```bash
    git https://github.com/AnsarIbrahim/hello-rails-back-end.git
    ```

    You need to setup database for these project

    ```
    development = hello_rails_back_end_dev
    test = hello_rails_back_end_test
    production = hello_rails_back_end_production
    ```

    or you can use your own database and change the ```config/database.yml```

    ```yml
    default: &default
    adapter: postgresql
    encoding: unicode
    pool: 5
    username: [your_username]
    password: [your_password]
    host: localhost

    development:
    <<: *default
    database: [your_database_for_development]

    test:
    <<: *default
    database: [your_database_for_test]

    production:
    <<: *default
    database: [your_database_for_production]
    ```

    ### Install

    Install this project with:

    ```bash
    cd hello-rails-back-end
    bundle install
    ```

    it will install the required gems for running the project

    ### Usage

    to use this project:

    ```ruby
    rails server -p 3000
    ```

    it will run the server on ```localhost:3000```

    (back to top)

    ## 👥 Author

    👤 **Ansar Ibrahim**

    - [GitHub](https://github.com/AnsarIbrahim)
    - [LinkedIn](https://linkedin.com/in/ansar-ibrahim/)
    - [Twitter](https://twitter.com/ansaradheeb)

    (back to top)

    ## 🔭 Future Features

    - Add User Interaction

    (back to top)

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

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

    (back to top)

    ## ⭐️ Show your support

    If you like this project you can share this project to your friend

    (back to top)

    ## 🙏 Acknowledgments
    - I'd like to thank Microverse for defining the project requirements

    (back to top)

    ## 📝 License

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

    (back to top)