Kuki

Air Monitor Web-App
· Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

A web-app that monitors the air and gives you various information regarding your environment. It gives you AQI and a brief Weather Report alongwith the forecast result of AQI and Weather. Gives you a brief report and suggestion to increase the quality of the air.

Here's why:

• Your time should be focused on creating something amazing. A project that solves a problem and helps others
• A project that solves air related problems
• For a better living 😄

(back to top)

Built With

This section should list any major frameworks/libraries used in my project.

• Node.js
• Express.js
• Fontawesome
• Bootstrap
• JQuery

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

_Below is an example of how you can use this.

1. Get a free API Key at https://example.com
2. Clone the repo

   git clone https://github.com/anupammaurya6767_/Kuki.git

3. Install NPM packages

   npm install

4. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

(back to top)

Roadmap

• Add Day-Night Feature
• Add New methods of prevention
• Make a Android App
• Multi-language Support
  • Hindi
  • Japanese

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

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!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU General Public License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/anupammaurya6767/kuki

Liked what I do? Thank You Very Much!

(back to top)