https://github.com/krystofwoldrich/via-project
Repository of VIA course semestral project
https://github.com/krystofwoldrich/via-project
Last synced: 2 months ago
JSON representation
Repository of VIA course semestral project
- Host: GitHub
- URL: https://github.com/krystofwoldrich/via-project
- Owner: krystofwoldrich
- Created: 2020-10-12T14:20:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-01-07T12:28:45.000Z (over 4 years ago)
- Last Synced: 2025-01-13T23:13:44.301Z (4 months ago)
- Language: JavaScript
- Size: 987 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Smart heating idea
This application will combine Google Calendar, weatherstack and custom apis, to create pleasing experience, when setting home heating.
Google calendar will be used to suggest turning heating down, to save on energy. The weather api will be used to suggest when to turn the heating on. And the custom api will take care of saving users preference and communications with the hardware of the smart heating.
[OpenWeather API Documentation](https://openweathermap.org/api/one-call-api) to get weather forecast.
[Google calendar API Documentation](https://developers.google.com/calendar/quickstart/js) shows how to use it in application front-end using javascript.
## How to develop
```bash
# Start the client application with hot-reload
export REACT_APP_API_BASE_URL=http://localhost:5000
export REACT_APP_GOOGLE_API_KEY=your_google_api_key
export REACT_APP_GOOGLE_CLIENT_KEY=your_google_client_key
export REACT_APP_OPEN_WEATHER_API_KEY=your_open_weather_key
cd client
npm install --ignore-scripts
npm run start
```
```bash
# Start the server api with hot-reload
export FLASK_ENV=development
export HEATING_API_SECRET_KEY=fill_in_your_secret_api_key
export HEATING_API_MONGO_URI=mongodb://your_mongo_instance:27017/
cd server
pipenv install
pipenv run python main/main.py
```
## Presentation
[Open in Google Slides.](https://docs.google.com/presentation/d/1CLocuMqYReHWZoPJi0ToZj_qzAQEAYn0Rd3DMnzcdIg/edit?usp=sharing)
## Progress
What has been done on the project categorized by weeks.
### 2021 Week 1
- Add server api facade
- Add mongo to server side for users, heatings and heatings schedules
- Add set heating schedule, update heating schedule using calendar
- Fix mapping from api objects to view object
- Many other fixes
### 2020 Week 53
- Add loading skeleton for weather and calendar views
- Add cors to server
- Fix jwt
- Add client login api connection
### 2020 Week 52
- Add dashboard, login, upcoming events and calendar demo view
- Add Google Auth and Calendar API
- Add material ui styles
- Add weather forecast view and API connection
### 2020 Week 51
- Added docker client, server image and docker compose
- Added user, heating, heating schedule endpoints with demo data
- Embedded Google Slides presentation in this documentation page
- Setup Redux CRA for front-end development
### 2020 Week 46
- Setup Github Pages, Basic documentation
- Setup Pipenv development environment
- Added simple Flask RestPlus API Server
- Added DateTime to ISO Converter
- Added User Authentication Endpoint