An React application on Air Quality Info
Explore the docs »
View Demo
·
Report Bug
·
Request Feature
Table of Contents
There are many great application about air quality indexes for cities available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a application about the air quality in cites so amazing that it'll be the last one you ever need -- I think this is it.
Here's why:
- Your time should be focused on creating something amazing. A project that solves a problem and helps others
- You should implement DRY principles to the rest of your life 😄
I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.
To get started you must set up your project locally. To get a local copy up and running follow these simple steps.
Things you need to use the software and how to install them.
- Get a free API Key at API Token Request Form
- Clone the repo
git clone https://github.com/dyarawilliams/AirQuality-Info-App.git
- Install NPM packages
npm install
- Create a file named
.envin the root of your project folder and Enter your API Token usingREACT_APP_AQI_API_TOKEN=
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
For more examples, please refer to the Documentation
- Add Changelog
- Add "components" folder for better structure
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt for more information.
D'yara Williams - @xchaoticrage - dyara.williams@gmail.com
Project Link: https://github.com/dyarawilliams/AirQuality-Info-App
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!