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

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


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

Last synced: 6 days ago
JSON representation

Awesome Lists containing this project

README

          

# 📗 Table of Contents

- [📗 Table of Contents](#-table-of-contents)
- [📖 Hello-rails-backend ](#-practice-test-driven-developmenttdd-)
- [🛠 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-backend application is a web application that can display APIs for random greetings.

## Front end repository

> [Front end](https://github.com/codehass/hello-react-front-end)

## 🛠 Built With

>

  • Ruby

  • >
  • Ruby on Rails

  • >
  • Postgresql
  • ### Key Features

    > - Display greetings.

    (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

    ### Setup

    - Clone this repository to your desired folder:

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

    - Navigate into the cloned folder

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

    ```

    - Install this project with:

    ```sh
    bundle install
    ```

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

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

    - Start the server

    ```sh
    rails s
    ```

    - Run tests

    ```sh
    rails db:migrate RAILS_ENV=test
    ```

    ```sh
    rspec spec
    ```

    - if it shows error try using this command

    ```sh
    bundle exec rspec spec
    ```

    (back to top)

    ## 👥 Authors

    👤 **Hassan EL OUARDY**

    - GitHub: [@codehass](https://github.com/codehass)
    - Twitter: [@hassanelourdy](https://twitter.com/hassanelourdy)
    - LinkedIn: [Hassan El OUARDY](https://www.linkedin.com/in/hassan-el-ouardy-360b99169/)

    (back to top)

    ## 🔭 Future Features

    - Personalized Greetings
    - Multi-Lingual Support
    - Voice Greetings

    (back to top)

    ## 🤝 Contributing

    Contributions, issues, and feature requests are welcome!

    Feel free to check the [issues page](https://github.com/codehass/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](./LICENCE) licensed.

    (back to top)