https://github.com/pskinnertech/guardian-site
Guardian: Decentralized Air Quality and Seismic Activity Monitoring - Website Repo 🌎🔍
https://github.com/pskinnertech/guardian-site
Last synced: about 2 months ago
JSON representation
Guardian: Decentralized Air Quality and Seismic Activity Monitoring - Website Repo 🌎🔍
- Host: GitHub
- URL: https://github.com/pskinnertech/guardian-site
- Owner: PSkinnerTech
- Created: 2023-04-08T02:36:53.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-13T10:47:54.000Z (about 3 years ago)
- Last Synced: 2025-03-13T23:25:48.119Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://guardian-site.vercel.app
- Size: 11.3 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README-DOCUMENTATION.txt
Awesome Lists containing this project
README
# **Guardian: Decentralized Air Quality Monitoring and Seismic Activity Detection System**
Guardian is an innovative, decentralized system designed to monitor air quality and detect seismic activity. Our mission is to improve early warning systems and provide communities with accurate, real-time data to protect public health and the environment.
## **Table of Contents**
* [**Getting Started**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#getting-started)
* [**Installation**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#installation)
* [**Usage**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#usage)
* [**Contributing**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#contributing)
* [**License**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#license)
* [**Team Members**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#team-members)
* [**Acknowledgements**](https://chat.openai.com/chat/db5388b7-f556-4d2d-91e3-614b9857e6c4#acknowledgements)
## **Getting Started**
These instructions will guide you through setting up the Guardian project on your local machine for development and testing purposes. For deployment on a live system, see the deployment section.
### **Prerequisites**
To run the Guardian project on your local machine, you will need to have the following tools installed:
* Node.js
* npm
* Git
### **Installation**
1. Clone the Guardian repository
```bash
bashCopy codegit clone https://github.com/GuardianProject/Guardian.git
```
1. Change directory to the cloned repository
```bash
bashCopy codecd Guardian
```
1. Install the required dependencies
```bash
bashCopy codenpm install
```
## **Usage**
To run the Guardian project on your local machine, execute the following command:
```bash
bashCopy codenpm start
```
This command will start the development server, and you can access the website by opening a web browser and navigating to [`http://localhost:3000`](http://localhost:3000).
## **Contributing**
We welcome contributions to the Guardian project! To contribute, please follow these steps:
1. Fork the repository
2. Create a new branch (`git checkout -b feature/YourFeature`)
3. Commit your changes (`git commit -m 'Add YourFeature'`)
4. Push to the branch (`git push origin feature/YourFeature`)
5. Open a Pull Request
## **License**
This project is licensed under the MIT License - see the [**LICENSE**](https://chat.openai.com/chat/LICENSE) file for details.
## **Team Members**
* Patrick Skinner - Co-founder, Full Stack Engineer
* Tony Kipkemboi - Co-founder, Software Engineer & Developer Relations
## **Acknowledgements**
We would like to express our gratitude to the following individuals and organizations for their support and contributions to the development of the Guardian project:
* Our friends and family for their encouragement and support
* Open source projects and libraries used in Guardian
* The developer community for their valuable insights and feedback
For more information about the Guardian project, please visit us at [**DEVELOPER DAO**](https://developerdao.com/)