Skip to content

covid-alert-ny/covid-green-push-api

 
 

Repository files navigation

Contact Tracing - Push Service Backend

Set up service

​ The push service is a Fastify server, connecting to the same PostgreSQL instance as the API service. ​

  • Install the dependencies and create a basic environment configuration. ​
npm install
npm run create:env

​​​

  • Finally, start the server in development mode. ​
npm run start:dev

Backend API Development

​ There are a number of handy commands you can run to help with development. ​

Command Action
npm run start:dev Run the server in dev mode, automatically restarts on file change
npm run create:env Create a new .env file
npm test Run unit tests
npm run test:watch Run backend tests in watch mode, running on changed test files
npm run lint Run eslint
npm run lint:fix Run eslint in fix mode

Team

Lead Maintainers

Core Team

Contributors

Past Contributors

  • TBD
  • TBD

Hosted By

Linux Foundation Public Health

Acknowledgements

License

Copyright (c) 2020 HSEIreland Copyright (c) The COVID Green Contributors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Packages

No packages published

Languages

  • JavaScript 97.9%
  • Dockerfile 2.1%