https://github.com/duanedave/hello-react-front-end

https://github.com/duanedave/hello-react-front-end

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/duanedave/hello-react-front-end
• Owner: DuaneDave
• Created: 2023-01-03T15:54:21.000Z (almost 2 years ago)
• Default Branch: dev
• Last Pushed: 2023-01-21T20:51:16.000Z (almost 2 years ago)
• Last Synced: 2024-10-24T14:24:49.834Z (2 months ago)
• Language: JavaScript
• Size: 354 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        




  
GREETING API




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Authors](#authors)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [❓ FAQ](#faq)

- [📝 License](#license)

# 📖 Greeting_APP 

**Greeting_API** is web app to display greetings from rails API with react as the front-end in two apps.

## 🛠 Built With 

### Tech Stack 

  Client

  


    
React js

  


  Server

  


    
Ruby on Rails

  


Database

  


    
PostgreSQL

  


### Key Features 

- **Setup API endpoints**

(back to top)


## 🚀 Live Demo 

- [Live Demo link coming soon]()

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

- [Node.js](https://nodejs.dev/en/) installed

- [Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable)

### Setup

Clone this repository to your desired folder:

```sh

  cd my-folder

  git clone https://github.com/DuaneDave/hello-react-front-end.git

```

### Install

Install this project with:

```sh

  cd hello-rails-back-end

  npm i

```

### Usage

To run the project, execute the following command:

```sh

  npm start

```

### Deployment

You can deploy this project using:

(back to top)


## 👥 Authors 

👤 **Obiebi Okiemute David**

- GitHub: [@githubhandle](https://github.com/DuaneDave)

- Twitter: [@twitterhandle](https://twitter.com/dave_duane)

- LinkedIn: [LinkedIn](https://www.linkedin.com/in/david-obiebi)

(back to top)


## 🔭 Future Features 

- [x] API authentication

- [x] API documentation

(back to top)


## 🤝 Contributing 

Contributions, issues, and feature requests are welcome!

Feel free to check the [issues page](https://github.com/DuaneDave/hello-rails-back-end/issues/new).

(back to top)


## ⭐️ Show your support 

If you like this project, kindly give me a ⭐️

(back to top)


## 🙏 Acknowledgments 

- I would like to thank [Microverse](https://www.microverse.org/) for inspiring this project

- I would like to appreciate [Render](https://render.com) for the plateform to deploy the API

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)


(back to top)