rayhantabase / hello-rails-back-end

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
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ (OPTIONAL)
• 📝 License

📖 [Hello Rails Back End ]

In this application I explore a rails api client whose data would be consumed by a seperate react front end clinet.

[hello_rails_backend] is an application to help explore how to connect react and use it to its maximum with rails application.

🛠 Built With

Tech Stack

This application was built using Ruby on Rails, react, redux, webback, postgreSQL

Client

• React.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• [Create_messages]
• [api_endpoint]
• [display_random_message]

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

Describe how a new developer could make use of your project.

You can find the React Frontend client at React_client

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Have ruby installed
• Have node installed
• Have rails installed

Setup

You can find the React Frontend client at React_client

Clone this repository to your desired folder:

To run and view this application, you will first have to clone a local version of this repository using:

git clone https://github.com/RayhanTabase/hello-rails-back-end.git

After that navigate to the newly created folder:

cd hello-rails-back-end

Install

Install this project with: bundle install

Usage

To run the project, execute the following command:

You can find the React Frontend client at React_client

Configure PostgreSQL database in your project in the project directory:

config/database.yml

Start a local server running the command:

rails s

Run tests

To run tests, run the following command:

Deployment

You can deploy this project using:

(back to top)

👥 Authors

Mention all of the collaborators of this project.

👤 Salim Abdulai

• GitHub: @RayhanTabase
• LinkedIn: Salim-Abdulai

(back to top)

🔭 Future Features

Describe 1 - 3 features you will add to the project.

• [authentication]
• [authorizations]
• [sessions]

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Write a message to encourage readers to support your project

If you like this project...

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank...

(back to top)

❓ FAQ (OPTIONAL)

Add at least 2 questions new developers would ask when they decide to use your project.

• [Question_1]

  • [Answer_1]

• [Question_2]

  • [Answer_2]

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)