# prysma
> NodeJS Light Management Service
Latest version **1.2.0** (published 2019-07-30) · MIT license · 0 weekly downloads
## Install
```sh
npm install prysma
pnpm add prysma
yarn add prysma
bun add prysma
```
Provides the command `prysma`.
## Health
**Score 30/100 (F)** — status: abandoned.
Positive: no vulnerabilities; high maintenance score.
Warnings: low downloads; no types; no esm support.
Negative: abandoned.
## Facts
| | |
|---|---|
| Version | 1.2.0 |
| Published | 2019-07-30 |
| First published | 2019-07-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Unpacked size | 3.3 MB |
| Known vulnerabilities | 0 (+7 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Nick Rook |
| Maintainers | rooknj |
## Links
- npm: https://www.npmjs.com/package/prysma
- Repository: https://github.com/Rooknj/prysma
- Homepage: https://github.com/Rooknj/prysma#readme
- Issues: https://github.com/Rooknj/prysma/issues
- npm.io page: https://npm.io/package/prysma
## Dependencies (16)
- [uuid](https://npm.io/package/uuid.md) ^3.3.2
- [dotenv](https://npm.io/package/dotenv.md) 8.0.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [graphql](https://npm.io/package/graphql.md) ^14.3.1
- [logform](https://npm.io/package/logform.md) ^2.1.2
- [sqlite3](https://npm.io/package/sqlite3.md) 4.0.9
- [typeorm](https://npm.io/package/typeorm.md) ^0.2.18
- [winston](https://npm.io/package/winston.md) ^3.2.1
- [async-mqtt](https://npm.io/package/async-mqtt.md) ^2.3.0
- [type-graphql](https://npm.io/package/type-graphql.md) ^0.17.4
- [class-validator](https://npm.io/package/class-validator.md) ^0.9.1
- [lodash.throttle](https://npm.io/package/lodash.throttle.md) ^4.1.1
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [class-transformer](https://npm.io/package/class-transformer.md) ^0.2.3
- [apollo-server-express](https://npm.io/package/apollo-server-express.md) ^2.6.7
- [graphql-subscriptions](https://npm.io/package/graphql-subscriptions.md) ^1.1.0
## Recent versions
- 1.2.0 (latest) — 2019-07-30
- 1.1.1 — 2019-07-23
- 1.1.0 — 2019-07-23
- 1.0.1 — 2019-07-14
- 1.0.0 — 2019-07-12
- 0.1.0-alpha — 2019-07-09
## README
[
](https://github.com/Rooknj/prysma)
# Prysma
[](https://travis-ci.org/Rooknj/prysma)
[](https://badge.fury.io/js/prysma)
[](https://renovatebot.com/)
[](https://github.com/prettier/prettier)
[](https://github.com/semantic-release/semantic-release)
NodeJS Light Management Service
## Installing
### Prerequisites
- Nodejs v10.15.3 or greater is required. Check by running `node -v`
- A Running MQTT broker (default location is localhost:1883. See Configuration section to change)
### Install globally with Yarn or NPM
yarn:
```
yarn global add prysma
prysma
```
npm:
```
npm install -g prysma
prysma
```
Notes:
- The default database is a sqlite database created at ~/.prysma/prysma.db
- The default MQTT Broker host used by prysma is localhost:1883
- These can be changed in the configuration (see Configuration section below)
## Developing
### Built With
- [Express](https://expressjs.com/)
- [Apollo-Server](https://www.apollographql.com/docs/apollo-server/)
- [TypeGraphQL](https://typegraphql.ml/)
- [TypeORM](https://typeorm.io/#/)
- [Async MQTT.js](https://github.com/mqttjs/async-mqtt)
### Prerequisites
- Nodejs v10.15.3 or greater is required. (Check by running `node -v`)
- Yarn (Check by running `yarn -v`)
- Docker (Check by running `docker -v`) (Used for tests and running an MQTT broker locally)
- Docker-compose (Check by running `docker-compose -v`) (Used for tests and running an MQTT broker locally)
### Setting up Dev
```
git clone https://github.com/Rooknj/prysma.git
cd prysma
yarn install
```
### Run Prysma locally
Using environment configuration (specified in .env file) or default configuration options
Note: run `docker-compose up` to start local services (or just use `yarn start --local`)
```
yarn start
```
With an automatically started MQTT broker running on localhost:1883 (Note: This requires docker and docker-compose to be installed)
```
yarn start --local
```
With an MQTT broker running at prysma.local:1883
```
yarn start --remote
```
### Testing
Tests are written using [Jest](https://jestjs.io/)
Run tests on watch mode:
```
yarn test
```
Run tests with coverage:
```
yarn test --coverage
```
Run tests once:
```
yarn test --no-watch
```
### Building
Compile Typescript (outputs to /dist)
```
yarn build
```
Compile Typescript and generate an executable using zeit/pkg (executable located in /build)
```
yarn build --createExecutable
```
### Deploying
Deployments happen automatically using Semantic-Release based off of commit messages
Build and publish Docker Image
Note: This docker image stores the database in the /data directory. Create a volume on it to persist data across container starts
```
yarn docker:build -t
yarn docker:publish -t
```
### Clean temporary Files
```
yarn clean
```
## Commit Messages
Commit messages must follow [Conventional Commits](https://www.conventionalcommits.org)
Example Messages
- chore(docs): updated Readme
- refactor: renamed LedStrip to Light
- fix(LightMessenger): fixed a bug where an incorrect message format was being used
- feat: Added ability to assign lights to different rooms
- BREAKING CHANGE: Removed deprecated functions
CI will fail if you do not use the correct commit format. Local messages are linted using [Commitlint](https://commitlint.js.org/#/)
Commitizen support coming soon
## Configuration
Prysma is configurable using environment variables
### Default Configuration
- PORT=80 (or 4001 if NODE_ENV=development)
- MQTT_HOST=localhost
- MQTT_PORT=1883
- MQTT_USERNAME=""
- MQTT_PASSWORD=""
- MQTT_RECONNECT_PERIOD=5000
- TYPEORM_CONNECTION=sqlite
- TYPEORM_DATABASE=[home directory]/.prysma/prysma.db (or [projectRoot]/.prysma/prysma.db if NODE_ENV=development)
- TYPEORM_SYNCHRONIZE=true
- TYPEORM_LOGGING=false
### Overriding default configuration with environment variables
1. Duplicate .env.template and rename to .env
2. Fill in the desired configuration options
3. Note: For overriding TypeORM configurations, make sure you include all required fields for the database you choose to use
### Other configuration variables
View available configuration environment variables in [.env.template](/.env.template).
## Versioning
We use [SemVer 2.0.0](https://semver.org/) for versioning. To see available versions, check out the [releases page](https://github.com/Rooknj/prysma/releases)
## Style Guide
### Linting
Linting is managed by [ESLint](https://eslint.org/)
Run `yarn lint` to check all files
Currently we are extending eslint:recommended, @typescript-eslint/recommended, airbnb-base, eslint-comments/recommended, and jest/recommended
Full config is located in [.eslintrc.js](/.eslintrc.js)
Note: The linter is ran during CI and the build will fail if there are any errors. Currently we are not automatically fixing linting errors so you will have to make sure the linter passes manually
### Code Style
Code style is managed by [Prettier](https://prettier.io/) [](https://github.com/prettier/prettier)
All default prettier styles are enabled except for the overrides located in [.prettierrc.js](/.prettierrc.js)
Prettier is automatically ran on staged files every commit using [Husky](https://github.com/typicode/husky) and [Lint-Staged](https://github.com/okonet/lint-staged)
You can run prettier manually on every file through the command `yarn reformat` or you can set up prettier to run inside your IDE/Editor
## License
This project is licensed under the terms of the
[MIT license](/LICENSE).
---
_Source: https://npm.io/package/prysma · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._