diff --git a/README.md b/README.md new file mode 100644 index 0000000..217c48e --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# SSR Tracing Backend +This is the backend API provider for the [SSR Tracing Web-App](https://github.com/naresh97/ssr-tracing). + +## Development +### Prerequisites +- NodeJS +- NPM + +### Building +- Run `npm install` to install the required packages +- Run `nodejs ./index.js` to start the server + +### .env +Server parameters are specified in the *.env* file, see *.env.template* for an example \ No newline at end of file