1.0.1 • Published 2 years ago

a11ywatch-core v1.0.1

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

a11ywatch-core

Maintainability

HTTP API for a11ywatch

Getting Started

Docker

  1. docker-compose up

Local Build

  1. npm install
  2. npm run dev

Database

Below is only needed to run locally currently.

  1. start mongodb locally and add the connection to the proper DB_URL env variable example mongodb://127.0.0.1:27017/?compressors=zlib&gssapiServiceName=mongodb.
  2. get mongodump contents from team member and run mongorestore.

Data Info

User

roles

free = 0
basic = 1
premium = 2
entreprise = 3

Emailing

To get the emailer working add your private.key and public.key to the root of the project through ssh or another method.

Release

In order to send a production build using a docker image make sure to add your servers private and pubic keys at the root of the sub directory before building.

LICENSE

check the license file in the root of the project.