📗 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

📖 BACKEND FOR HELLO REACT RAILS

This is a project to learn how to use React with Rails by Implementing a connection between a Ruby on Rails back-end and React front-end. This project contains the backend part of it.

Hello react rails is a simple web app to test working with rails and react in a fullstack web devevelopment project.

🛠 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/Backend_Hello_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 for this backend:

https://github.com/NATASHA-ct/Backend_Hello_Rails_React.git

Link to frontend repository

https://github.com/NATASHA-ct/frontend_hello_rails_react.git

Link to frontend repository pull request

https://github.com/NATASHA-ct/frontend_hello_rails_react/pull/1

• Once you have your repository cloned on your machine, feel free to modify it as needed.

  • To add to your own page on the browser link

  • To run the project, execute the following command in your terminal: rails s

  • Add the following endpoint on the browser link http://localhost:3000 inorder to view the api with all greetings api/v1/greetings

Install

` Navigate to the created folder.

- Initialize your project with Git.
- Make sure that your project has Postgres database set up.
- Run rails server and visi thttp://127.0.0.1:3000/ in your browser!
- git clone [email protected]:NATASHA-ct/Backend_Hello_Rails_React.git
- cd Backend_Hello_Rails_React
- bundle install install
- rails s

### run the following in your terminal:
- gem install rails
- gem install pg
- bundle install (use this whenever you want add a gem in your gem file)
- rails db:create
- change your database password to suit yours in database.yml `



To check linters locally, use

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

`$ bin/rails db:setup`

Usage

--Once you have your repository cloned on your machine, feel free to modify it as needed.

• To add your own page

• To run the project, execute the following command: rails s

• Add the following endpoint inorder to view the api with all greetings api/v1/greetings

• Add the following endpoint inorder to view the api with all greetings api/v1/greetings/:id

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