MattGomb/hello-rails-back-end

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 Hello-rails-back-end

This project is the back-end half of experimenting with React/Rails in two separate repos. You can find the React-half HERE

🛠 Built With

Tech Stack

Server

• Rails

Database

• PostgreSQL

Key Features

• [Random greeting/saying generation on api endpoint]

(back to top)

🚀 Live Demo

• There is no live demo of this project

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

• Rails
• PostgreSQL

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone git@github.com:MattGomb/hello-rails-back-end.git

Install

Install this project with:

bundle install

npm install

or

yarn install

Usage

TThis app uses PostgreSQL databases for data preservation. Please provide valid credentials in a .env file and place it in the root folder.

To initialize the database run:

rails db:create

rails db:migrate

There are a couple of prepared messages, if you don't want to add them through the console:

rails db:seed

To run the server, execute the following command:

rails s` or `rails server

this will start the server on http://localhost:3000/

Run tests

N/A

Deployment

N/A

(back to top)

👥 Authors

👤 Mátyás Gombos

• GitHub: @MattGomb
• Twitter: @MtysGombos1
• LinkedIn: LinkedIn

(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 please consider giving it a star!

(back to top)

🙏 Acknowledgments

I would like to thank Microverse for the opportunity

(back to top)

📝 License

This project is MIT licensed.

(back to top)