theodoraldo / hello-react-frontend

A react application for frontend dev. It's set and configured to communicate with rails application (hello-rails-backend) that queries data from PostgreSQL database.

📗 Table of Contents

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

📖 [Hello React Frontend]

[Hello-React-Frontend] A react application for frontend dev. It's set and configured to communicate with rails application (hello-rails-backend) that randomly queries data(messages) from PostgreSQL database.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• Bulma CSS
• React

Database

• PostgreSQL

Server

• Ruby
• Ruby on Rails

Key Features

• [Retrieving data from hello-rails-backend API endpoint]
• [Using react store in handling request to API]
• [Displaying data on the webpage using react greeting component]

(back to top)

🔗 Back End Link

My Hello Rails Backend code is stored in a separate repository and is built using ruby on rails. The backend is responsible for processing data to handle API requests. To access our backend code, please click here.

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

• Ruby on Rails installed and running. To get more information, read the installation guide.

• PostgreSQL installed and running

(back to top)

Setup

Clone this repository to your desired folder:

  cd my-folder
  https://github.com/Theodoraldo/hello-react-frontend.git 

(back to top)

Install

Install this project with:

    cd hello-react-frontend
    npm install

(back to top)

Usage

To run the project, execute the following command:

  npm start

(back to top)

Run tests

To run tests, run the following command:

  npm test

(back to top)

👥 Authors

👤 Theodore Asimeng-Osei

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

🤝 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 it a star.

(back to top)

🙏 Acknowledgments

• We would like to thank Microverse and anyone who contributed to the success of this project. If we am to mention names, this readme cannot hold the list 😁😁.

(back to top)

📝 License

This project is MIT licensed.

(back to top)