Skip to content

Commit

Permalink
Improve project naming
Browse files Browse the repository at this point in the history
Rename from prikka to ruuvi-station-influx-gateway
  • Loading branch information
aleksihakli committed May 14, 2020
1 parent b847e1f commit fb1708a
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Prikka
# ruuvi-station-influx-gateway

This project offers an open-source implementation for
[Ruuvi Station](https://ruuvi.com/manuals/station/app-settings/)
Expand All @@ -7,10 +7,10 @@ measurements from RuuviTag to an InfluxDB 1.8+ and 2.0+ time-series database.

This application has been tested to work with the following setup:

RuuviTag (Ruuvi hardware sensor)
> Ruuvi Station (Ruuvi mobile application)
> Prikka (this project)
> InfluxDB 2.0 (free-to-use SaaS cloud)
RuuviTag (Ruuvi hardware sensor)
> Ruuvi Station (Ruuvi mobile application)
> ruuvi-station-influx-gateway (this project)
> InfluxDB 2.0 (free-to-use SaaS cloud works)

**Please note** that this is a community project under MIT license.

Expand All @@ -24,7 +24,7 @@ Creating an account should only take a few minutes.
1. Setup an InfluxDB server and organization at e.g. [InfluxDB Cloud](https://cloud.influxdata.com/).
2. [**Create Bucket** for InfluxDB](https://v2.docs.influxdata.com/v2.0/organizations/buckets/create-bucket/).
3. [Generate **Read/Write Token** for InfluxDB](https://v2.docs.influxdata.com/v2.0/security/tokens/create-token/).
4. Clone the repository with `git clone [email protected]:ruuvi/prikka.git`.
4. Clone the repository with `git clone [email protected]:ruuvi/ruuvi-station-influx-gateway.git`.
5. Copy `.env.example` to `.env` and configure necessary environment flags.
6. Run the service with e.g. `docker-compose up --build`.
7. Set your Ruuvi Station mobile application to point to the service at `http://<ip>:<port>/api/station`.
Expand Down Expand Up @@ -71,7 +71,7 @@ aside from dependencies defined in `package.json` and `package-lock.json`.

Deployment package into a cloud environment could be achieved with:

zip prikka.zip index.js package.json
zip ruuvi-station-influx-gateway.zip index.js package.json

Configuration in serverless environments is ideally achieved without
hardcoding the configuration flags and all environments should support
Expand Down
4 changes: 2 additions & 2 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

version: "3.7"
services:
prikka:
ruuvi-station-influx-gateway:
build: ./
image: prikka:latest
image: ruuvi-station-influx-gateway:latest
restart: unless-stopped
env_file:
- .env
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "prikka",
"name": "ruuvi-station-influx-gateway",
"version": "0.1.0",
"main": "index.js",
"repository": "https://github.com/aleksihakli/prikka",
"repository": "https://github.com/ruuvi/ruuvi-station-influx-gateway",
"license": "MIT",
"scripts": {
"start": "node index.js"
Expand Down

0 comments on commit fb1708a

Please sign in to comment.