Skip to content

kristiankunc/VatNotif-api

Repository files navigation

VatNotif API

The api server used to track online controllers for VatNotif (https://vatnotif.kristn.co.uk/)

This api is free to use by anyone without any API key required.

Documentation for this api can be found at https://api.vatnotif.kristn.co.uk/docs

Development setup

A MYSQL database is required, the prisma schema is defined prisma/schema.prisma. Database connection string has to be added to a .env file

  1. After cloning, install dependencies using NPM
$ npm i
  1. Generate the prisma client API using
$ npx prisma genrate
  1. Start the server
$ npx tsx src/index.ts

License

This project is released under the MIT License - see the LICENSE. file for details.

Contributing

Contributions are welcome, feel free to fork the project and submit a PR. This project follows the Contributor Covenant Code of Conduct, by participating you are expected to follow it.

Thank you for your contributions!

Releases

No releases published

Sponsor this project

Packages

No packages published