Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.31 KB

README.md

File metadata and controls

53 lines (34 loc) · 1.31 KB
Raw

Photosphere Node.js backend

This is the backend for the Photosphere application. It is a REST API to upload, managed and retrieve assets like photos and videos.

Setup

First, follow the instructions in the main readme.

Then open a terminal and change directory to the backend project:

cd backend

Run it in development

Start the application in development mode with live reload:

pnpm run start:dev

Test the REST API

Install VS Code REST Client and you can use the HTTP request scripts in ./test/backend.http to test the endpoints in the REST API.

Run in production

Start the application in production mode:

pnpm start

Run tests

pnpm test

Environment variables

  • NODE_ENV - Set to "production" to enable AWS cloud storage.
  • AWS_BUCKET - Sets the name of the AWS S3 bucket to use for storage.
  • AWS_DEFAULT_REGION - Sets the AWS region.
  • AWS_ACCESS_KEY_ID - The access key for your AWS account.
  • AWS_SECRET_ACCESS_KEY - The secret access key for your AWS account.
  • AWS_ENDPOINT - Custom endpoint if required. This is used for contecting to Digital Ocean Spaces instead of AWS S3.

Auth0 authentication details:

  • AUTH0_DOMAIN
  • AUTH0_BASE_URL