Secretary: your personal assistant

Website Known Vulnerabilities codecov Maintainability GitHub code size in bytes GitHub repo size Docker Image GitHub commit activity License: Common Public License Version 1.0 Issuehunt

About

Text diary, food analyze, health watcher, sleep analyze

Install

Dev only

npm i
chmod +x scripts/prepare
scripts/prepare

For HTTPS

Add host for local development

127.0.0.1       bot.lh
mkdir cert;
openssl req -x509 -newkey rsa:2048 -keyout certs/server/bot-key.pem -out certs/server/bot-cert.pem -days 365 -nodes -subj "/CN=bot.lh" -addext "subjectAltName=DNS:bot.lh"

For MacOS add certificate to trusted

sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain certs/server/bot-cert.pem

Run dev server

npm run dev:secure

ENVIRONMENTS

Copy .env.example to .env and fill in the required values. Do not commit .env.

Required values: TELEGRAM_TOKEN, HOST, SECRETARY_HOST, APP_URL, CLIENT_ID, and CLIENT_SECRET.

Tests

Unit

npm run test:unit [-- --watch]
#npm run test:unit [-- --match='config']

Run the full package check:

npm run test

Tools

Package upgrade

ncu -u

Fix lint

npm run lint -- --fix --quite

Show dependencies graph

brew install graphviz
npm run report:dependency

Validate dependencies

npm run lint:dependency

docs only Dev

Install

sudo gem install bundler jekyll
cd docs
bundle install

Run

npm run dev:docs

Docker Image

docker compose --env-file .env up --build

Run Telegram Bot Dev

docker compose --env-file .env up -d

Возможности управления системой

  1. something text - Уведомление
  2. ? something search - Поиск
  3. ! something execute - Выполнение поручения

Make with Manifest GIC DAO.