Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ssekpius/microverse-react-capstone-project---metrics-webapp
https://github.com/ssekpius/microverse-react-capstone-project---metrics-webapp
Last synced: 19 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ssekpius/microverse-react-capstone-project---metrics-webapp
- Owner: SSEKPIUS
- License: mit
- Created: 2023-01-18T08:23:19.000Z (almost 2 years ago)
- Default Branch: Dev
- Last Pushed: 2023-01-21T19:47:44.000Z (almost 2 years ago)
- Last Synced: 2024-10-03T11:43:16.543Z (about 1 month ago)
- Language: JavaScript
- Size: 1.47 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Metrics-webapp,
Metrics webapp,
This React capstone project is about building a mobile web application to check a list of metrics (numeric values) that we will create making use of React and Redux.
Metrics webapp
# 📗 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)
> API that provides numeric data about a topic that i like and then build the webapp around it. The webapp will have several pages:
one page with a list of items that could be filtered by some parameters; in the example below, it's a list of metrics that can be filtered by the country (imagine a search field to introduce the country name like Italy, Croatia, etc.). This page should be your homepage.
one page for the item details; in the example, the detail page for Czech Republic cities with number of views.
React.js, Node.js, Reduxt.js, CSS
Client
> Key features of the application.
- **[Retrive list of countries]**
- **[Get weather data based on the selected country]**
> Add a link to your deployed project.
- [Live Demo Link](https://sp-metrics-app.netlify.app)
> How a you could make use of this project.
To get a local copy up and running, follow these steps.
### Prerequisites
In order to run this project you need these, incase they are not already setup, Kindly Read [Prerequisites](./Prerequisites.md).
### Setup
Clone this repository to your desired folder:
```sh
mkdir my-folder
cd my-folder
git clone [email protected]:SSEKPIUS/Microverse-React-Template--quick.git
```
### Install
Install this project with:
```sh
npm install -force
```
### Usage
To run the project, execute the following command:
Example command:
```sh
npm run start
```
### Run tests
To run tests, run the following command:
Example command:
```sh
npm test
```
### Deployment
You can deploy this project using:
> collaborators of this project.
👤 **Author 1**
1. Ssekweyama Pius
- GitHub: [@githubhandle](https://github.com/SSEKPIUS)
- Twitter: [@twitterhandle](https://twitter.com/SSEK_PIUS)
- LinkedIn: [LinkedIn](https://linkedin.com/in/pius-ssekweyama-23665794)
>features i will add to the project.
- [ ] **[weather for cities]**
Contributions, issues, and feature requests are welcome!
Feel free to check the [issues page](../../issues/).
> We encourage you to support this project
If you like this project, kindly donate a token at [Paypal]()
> Credit to everyone who inspired this codebase.
👤 **Original Design 1**
- Original design idea by [Nelson Sakwa](https://www.behance.net/sakwadesignstudio) on Behance.
- I would like to thank microverse student team for the resorces availed.
> Questions new developers would ask when they decide to use this project.
- **What is front-end, HTML, CSS and JavaScript**
- The front end refers to the parts of the application that users (also known as "clients") interact with directly
- As a front-end dev, you'll implement these tasks primarily using HTML to define the structure of web pages, CSS to add styling, and JavaScript to add interactivity.
- **What is back-end and Full stack**
- The back end refers to the parts of the application that run behind the scenes and aren't presented directly to the user/client.
- The back end typically includes a web server which handles HTTP connections received from the front-end client (usually a web browser)
- Full stack simply includes both the front end AND back end!
This project is [MIT](./LICENSE) licensed.
_NOTE: we recommend using the [MIT license](https://choosealicense.com/licenses/mit/) - you can set it up quickly by [using templates available on GitHub](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository). You can also use [any other license](https://choosealicense.com/licenses/) if you wish._