https://github.com/ThymeApp/thyme-capsule

Thyme Capsule service for Thyme
https://github.com/ThymeApp/thyme-capsule

nodejs thyme thyme-capsule time-logging time-tracking web-service

Last synced: about 1 month ago
JSON representation

Thyme Capsule service for Thyme

• Host: GitHub
• URL: https://github.com/ThymeApp/thyme-capsule
• Owner: ThymeApp
• License: mit
• Created: 2018-05-12T14:07:12.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-21T11:52:38.000Z (over 5 years ago)
• Last Synced: 2024-08-01T12:32:11.666Z (4 months ago)
• Topics: nodejs, thyme, thyme-capsule, time-logging, time-tracking, web-service
• Language: JavaScript
• Homepage: https://usethyme.com
• Size: 305 KB
• Stars: 3
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - ThymeApp/thyme-capsule - Thyme Capsule service for Thyme (nodejs)

README

        
# Thyme Capsule

This service provides user authentication and state syncing for the [Thyme](https://github.com/Gaya/thyme) time tracking app.

Run this service on your own server or used the hosted version on [https://usethyme.com](https://github.com/Gaya/thyme).

### Starting the service

`$ npm start`

### Running linting and tests

`$ npm test`

## Running your own instance

This repository has deployment setup for deploying on [Heroku](https://www.heroku.com/) or Herokish systems like [dokku](http://dokku.viewdocs.io/dokku/).

Make sure you link a database container using MySQL or MariaDB and expose the connection URL as the `DATABASE_URL` environment variable.

Set the [environment variables](#available-environment-variables) when running in production for security, especially the encryption key and JWT secret.

Read more about connecting the Thyme app to your instance in the [Thyme docs](https://github.com/Gaya/thyme).

## Available environment variables

Create a `.env` file in the root of the project and it will be used to extend `process.env`.

```

ENV=production/development/test

PORT=5000

ENCRYPTION_KEY=secret-key-for-encryption

SALT_ROUNDS=10

DATABASE_URL=database://connection-url

JWT_SECRET=jwt-hash-secret

APP_PACKAGE_LOCATION=https://raw.githubusercontent.com/ThymeApp/thyme/master/package.json

STRIPE_KEY=stripe-secret-key

STRIPE_PLAN_EUR=stripe-plan-id

STRIPE_PLAN_USD=stripe-plan-id

STRIPE_WEBHOOK_SIGNATURE=stripe-webhook-signing-secret

MAILGUN_DOMAIN=mg.usethyme.com

MAILGUN_API_KEY=secret-key

SENTRY_DSN=sentry-dns

```