README.md

Climactic

Over the air environmental data collection and statistics

View Demo · Report Bugs · Request Feature

Table of Contents

• About the Project
  • Features
  • Stations
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• License
• Contact

About The Project

Climactic is a system that lets you monitor real time environmental data from "stations" anywhere on your network as well as visualize historical data and statistics.

Features

Climactic is still in early beta features might change at any time

Current features

• Automatic device discovery
• Desktop/Mobile Web Application
  • View station data
  • Manage stations

Planned features

• Data collection
• Statistic generation
• Data visualization (graphs, etc)

Stations

Stations are network enabled devices that provide environmental data.

You can have as many stations as you want and assign them names.

Stations currently measure 3 different environmental data

• Temperature
• Humidity
• Pressure

Read more about them at antoinegag/climactic-stations

Built With

• NodeJS
• React
• SQLite
• TypeScript
• GraphQL and Apollo GraphQL
• Express
• reactstrap
• Font Awesome
• Formik
• ... and more!

Getting Started

WARNING: this project is still in early development phase, if you want to work on it consider contacting me first by opening an issue or on twitter @antoinegag_dev

To get a local copy up and running follow these simple steps.

Prerequisites

• Yarn or NPM

Installation

1. Clone the repo

git clone https:://github.com/antoinegag/climactic.git

2. Install the dependencies

Since we have two modules here, you will need to go into both and install the deps.

You can run this command to download all packages

yarn && cd client && yarn && cd ../server && yarn && cd ..

or if you use npm

npm i && cd client && npm i && cd ../server && npm i && cd ..

3. Start the server with yarn dev or npm run dev

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Twitter: @antoinegag_dev

Project Link: https://github.com/antoinegag/climactic