Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnandersen777/smartplanter
IoT Smart Planter
https://github.com/johnandersen777/smartplanter
Last synced: about 14 hours ago
JSON representation
IoT Smart Planter
- Host: GitHub
- URL: https://github.com/johnandersen777/smartplanter
- Owner: johnandersen777
- License: mit
- Created: 2018-03-12T01:09:59.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-06-13T16:58:32.000Z (over 6 years ago)
- Last Synced: 2024-10-24T09:12:37.449Z (25 days ago)
- Language: JavaScript
- Homepage: https://web.cecs.pdx.edu/~jsa3/smartplanter/
- Size: 304 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Smart Planter PWA Client
IoT Smart Planter PWA Client
## Dependencies
`nodejs` and `npm` are required to run webpack to build the JavaScript client in
this project. If you do not have `node` / `npm` installed you can install it
with the following script.
```console
curl -L https://gist.github.com/pdxjohnny/75dee455b7ddb7334b88/raw/9828b128a6d927e9457cd0d92c8b51660a79ffbe/node-user.sh | bash && source ${HOME}/.bashrc
```
## Setup
```console
cd ~/public_html/
git clone [email protected]:pdxjohnny/smartplanter smartplanterdev
cd smartplanterdev
./scripts/setup.sh
```
The smartplanter app is now accessible at
`echo https://web.cecs.pdx.edu/~$USER/smartplanter/dist/`
## VAPID Keys for Push Notifications
These are currently committed to the repo. To re-generate run the create-vapid
script.
Keys are only committed to the repo now because storage of them in a secure way
would be complex to manage. Under no circumstances should they become publicly
available. If this application is to become production ready they must be stored
in a secure location and deployment should account for their retrieval at time
of application stand up.
```console
./scripts/create-vapid
```
## Favicons
Generated with [RealFaviconGenerator](https://realfavicongenerator.net/)
## Force HTTPS with htaccess
Put this htaccess file in your public_html folder.
```console
cat > ~/public_html/.htaccess <<'EOF'
RewriteEngine On
RewriteCond %{HTTPS} !=on
RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [L,R=301]
EOF
```
## API
### Create User
Endpoint returns a JSON with user ID and a JWT which should be used in the
Authorization header.
```console
curl 'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/createuser/?password=test'
# export TOKEN=`result of token in the above JSON reponse`
```
### Login
```console
curl 'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/login/?id=42&password=test'
# export TOKEN=`result of token in the above JSON reponse`
```
### Create Resource
```console
curl -H "Authorization: Bearer $TOKEN" \
-d 'Hello World'
'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/sync/'
```
### Update Resource
```console
curl -X PUT \
-H "Authorization: Bearer $TOKEN" \
-d 'Hello World'
'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/sync/?resource='
```
### Get Resource
```console
curl -H "Authorization: Bearer $TOKEN" \
'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/sync/?resource='
```
You should see `Hello World`
### Create Planter
```console
curl -H "Authorization: Bearer $TOKEN" \
'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/createplanter/'
# export PTOKEN=`result of token in the above JSON reponse`
```
### Update Planter
```console
curl -X PUT \
-H "Authorization: Bearer $PTOKEN" \
-d 'Hello World'
'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/sync/'
```
### Get Planter
```console
curl -H "Authorization: Bearer $PTOKEN" \
'https://web.cecs.pdx.edu/~jsa3/smartplanter/api/sync/'
```
## TODO
- Push notifications (WebPush incompatibility with php 7.0 only compatible with
7.1 and above, fork and fix)
- Offline compatibility (All libs use fetch and the mixed content hack doesn't
work with that)
- UX Improvements, notification of planter received changes
- Increase bcrypt cost to something secure