https://github.com/inspecta/hello-react-front-end
A simple react application that displays a random greeting fetched from a rails API
https://github.com/inspecta/hello-react-front-end
Last synced: 3 months ago
JSON representation
A simple react application that displays a random greeting fetched from a rails API
- Host: GitHub
- URL: https://github.com/inspecta/hello-react-front-end
- Owner: inspecta
- Created: 2023-02-21T10:38:32.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-02-21T18:07:52.000Z (over 3 years ago)
- Last Synced: 2025-05-16T04:37:05.234Z (about 1 year ago)
- Language: JavaScript
- Size: 760 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
RAILS-FRONT-END README
# 📗 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 (OPTIONAL)](#faq)
- [📝 License](#license)
This is a simple React application that fetches data from an API endpoint and displays the data. It is developed using React and Redux (State management).
State Management
Front End
Database
- None
> Describe between 1-3 key features of the application.
- Fetch data from an API endpoint
- Store the data in a store
- Display the data in a component
> Describe how a new developer could make use of your project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need:
- NodeJS
- Node Package Manager (NPM)
### Setup
Clone this repository to your desired folder:
```sh
git clone https://github.com/inspecta/hello-react-front-end.git
```
### Install
Install this project and it's dependencies:
```sh
cd hello-front-end
npm install
```
### Usage
To run the project, execute the following command:
```sh
npm start
```
> Mention all of the collaborators of this project.
👤 **Author1**
- GitHub: [@inspecta](https://github.com/inspecta)
- Twitter: [@djmulinde](https://twitter.com/djmulinde)
- LinkedIn: [LinkedIn](https://linkedin.com/in/mulinde-derrick)
> Describe 1 - 3 features you will add to the project.
- [ ] A better UI
- [ ] A compelete application
- [ ] More functionality
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> Write a message to encourage readers to support your project
If you like this project, please give it a star.
> Give credit to everyone who inspired your codebase.
I would like to thank Microverse for their continued support. They've provided us with the reading material that have helped us to create this application.
> Add at least 2 questions new developers would ask when they decide to use your project.
- **Can I reuse this code?**
- Yes sure, feel free.
- **Are contributions welcome?**
- Yes please. Contact me at `djmulinde@gmail.com` and I will be happy to add you as a contributor.
This project is [MIT](./LICENSE) licensed.