symfi-api

Backend service for the Symfi application.

Environment Variables

Main

• DEBUG: (true | undefined) – debug mode, prints additional logs
• LOG_REQUESTS: (true | undefined) – log all incoming requests
• NODE_ENV: ('test' | undefined) – environment to run the server in
• PORT: (number | undefined) – port to run the server on

API V2, V3

• PROXY_DOWNLOAD_ENABLED: (true | undefined) – makes the server act as a proxy for downloading audio files
• PROXY_DOWNLOAD_ORIGIN: (string | undefined) – origin to proxy download, (requires: PROXY_DOWNLOAD_ENABLED)

API V3

• PROXY_DOWNLOAD_STREAM_ENDPOINT: (true | undefined) – uses newer "/stream" endpoint for proxy download, (requires: PROXY_DOWNLOAD_ENABLED)

License

Licensed under the MIT License.

Scripts

• npm run build - compiles TypeScript
• npm run build:watch - compiles TypeScript and watches for changes
• npm run lint - runs linter
• npm run lint:fix - runs linter and fixes issues
• npm run start - starts the server
• npm run start:watch - starts the server and watches for changes
• npm run test - runs e2e tests