elarhadu / hello-rails-back-end

HELLO RAILS BACK-END

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Front-End Link
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors

• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

HELLO RAILS BACK-END

Hello Rails Backend holds the Backend development source rails api of an app that displays random greetings

🛠 Built With

Tech Stack

Server

• Ruby on Rails

Database

• PostgreSQL

Key Features

• Random display of greetings

(back to top)

(back to top)

🚀 Front-End Link

Hello Rails

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

• To install ruby on your PC. You can read this documentation on how to do so
• To install postgresql on your PC. You can read this documentation on how to do so
• Know how to navigate directories or folders at the CLI.
• Know how to get the URL(https/ssh) of a repository on GitHub.
• You should have a code editor installed, preferably VSCode
• In order to run this project you need:

Setup

In desired folder or directory in the CLI, run the command:

git clone [e-mail]:elarhadu/hello-rails-back-end.git

Navigate into the cloned folder or repository by running the command:

cd hello-rails-back-end

If VsCode is your default code editor, run:

code .

You are all set up!

Install

Install this project with:

 bundle install

Usage

To setup the database, run

rails db:create db:migrate db:seed

Run tests

To run tests, run the following command:

  rspec spec

Deployment

To run the project, execute the following command:

ruby bin/rails server

You can deploy this project using:

http://[::1]:3000
or
http://127.0.0.1:3000
or
localhost:3000

(back to top)

👥 Author

👤 Emmanuella Adu

• GitHub: @elarhadu
• Twitter: @elarh_
• LinkedIn: Emmanuella Adu

(back to top)

🔭 Future Features

• Create a feature that allows users to create a new greeting

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project give me a ⭐

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for this project inspiration.

(back to top)

📝 License

This project is MIT licensed.

(back to top)