PrangonGhose / hello-rails-back-end

This is a demo application to practically experience the API connection between a Rails API application and a React-Redux application. This repository only has the files necessary to create the SQL database and the API. The hello-rails-front-end repository consists of the files necessary for the front end of this demo application.

Hello React-Rails Backend

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Key Features
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🔭 Future Features
• 🙏 Acknowledgements
• 📝 License

📖 Project Name

Hello React-Rails Backend

This is a sample project.

About this project

This is a demo application to practically experience the API connection between a Rails API application and a React-Redux application. This repository only has the files necessary to create the SQL database and the API. The hello-rails-front-end repository consists of the files necessary for the front end of this demo application.

🛠 Built With

• Ruby, Ruby on Rails, Rails API

Key Features

Key features of the application.

• A demo app for practicing the rendering of data in React from an SQL database via Rails API.

(back to top)

💻 Getting Started

To clone the repository in local environment try following steps.

Prerequisites

• A code editor like Visual Studio Code with Git and Node.js.

You can check if Git is installed by running the following command in the terminal.

$ git --version

Likewise for Ruby and gem for package installation.

$ ruby --version && gem --version

Note: This project is built with Ruby version 3.1.3

Setup

Clone the repository using this link.

Install

In the terminal, go to your file directory and run this command.

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

Get into development

In the terminal, run these commands to get into development.

$ cd hello-rails-back-end

$ bundle init

$ bundle install (install dependencies)

Note: You might need to update database.yml for development and testing environments with necessary username and password for your database in their respective positions. Because of free deployment, sending of user confirmation email option can take several hours to reach to the user mail box.

$ rails db:create

$ rails db:migrate

$ rails server

(back to top)

👥 Authors

👤 Prangon Ghose

• GitHub: @PrangonGhose
• LinkedIn: Prangon Ghose

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome! Add suggestions by opening new issues.

Feel free to check the issues page.

(back to top)

🔭 Future Features

• Adding API functionalities and frontend design.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

Authors would like to thank:

• Microverse
• Code Reviewers
• Coding Partners

(back to top)

📝 License

This project is MIT licensed.