HELLO-REACT-RAILS

📗 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
• 📝 License

📖 HELLO REACT RAILS

A simple web api application that has a front-end built using React JS and uses a web service from a ruby on rails driven backend

Hello react rails is a simple web app to test working with rails and react.

🛠 Built With

Tech Stack

These are technologies that I used.

Client

• React.js

Server

• Express.js

Database

• PostgreSQL

Key Features

Describe between 1-3 key features of the application.

• This app has API end points
• It fetches from the API and renders the data
• It renders random greetings on refreshing and navigating to the './ message

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

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

To get a local clone the repository https://github.com/NATASHA-ct/fullstack-rails-react.git

Prerequisites

In order to run this project you need:

• Ruby
• Postgresql
• Node.js
• Yarn
• Rails

Setup

Clone this repository to your desired folder: $ git clone

https://github.com/NATASHA-ct/fullstack-rails-react.git

$ cd hello_rails_react

Install

Install this project with: $ bundle install

To get all the gems required for the project

Then, run

$ npm install To install packages such as style linters

To check linters locally, use

$ rubocop $ npx stylelint "**/*.{css,scss}" Once you have the project correctly set up, run

$ bin/rails db:setup Usage To run the project, execute the following command:

./bin/dev or rails s

Usage

To run the project, execute the following command:

./bin/dev or rails s

👥 Authors

👤 Natasha Tatenda Chirombe

• GitHub: [@NATASHA-ct]((https://github.com/NATASHA-ct)
• Twitter: [@NatashaChirombe]
• LinkedIn: Natasha Chirombe

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Acknowledgement to all used sources e.g stackoverflow for debugging

(back to top)

🙏 Acknowledgments

Acknowledgement to all used sources e.g stackoverflow for debuggin

(back to top)

❓ FAQ

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

[Question_1] Do I need to have a program to manage the database.

[Answer_1] Yes you need postgesql or sqllite ,check installation online.

[Question_2] Can I access the owner database .

[Answer_2]No because its on their local database .

[Question_3] Does this app need 2 repositories.

[Answer_3] [No, this is a one repository frontend and backend app]

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