VigilArt

Our goal: help artists protect their work online.

Currently working on a website and a mobile app!

About

• Upload your artworks to the app.
• Get regularly notified about where your artworks appear online, all in one dashboard.
• Take action with automatically generated DMCA reports to remove unauthorized uses of your artworks.

Status

Getting started

Quick steps to run the project locally.

Prerequisites

• Node.js (recommended >= 18)
• pnpm (install: npm install -g pnpm)
• Doppler CLI (used to inject secrets at runtime)

For Windows users

See Windows-specific setup instructions.

Install dependencies

From the repository root:

pnpm install

Development Mode

• Uses docker-compose.dev.yml to easily start the database and Prisma Studio for local development.
• Loads environment variables from a local .env file at the root of the repository (see .env.example).
• Suitable for local development, debugging, and testing.

Start the database and Prisma Studio:

docker compose -f docker-compose.dev.yml up db
docker compose -f docker-compose.dev.yml up prisma-studio

You can also start both at once:

docker compose -f docker-compose.dev.yml up

Note: Make sure your .env file is present and contains all required variables.

Start the backend and frontend for development:

From the repository root, use the following scripts:

pnpm dev          # Starts both backend and frontend
pnpm dev:backend  # Starts only the backend
pnpm dev:frontend # Starts only the frontend

This allows you to use hot-reloading and other dev features outside of Docker for the app code, while still using Docker for the database and Prisma Studio.

Production Mode

• Uses docker-compose.prod.yml
• Loads secrets and environment variables via Doppler CLI (secure secret management)
• Suitable for deployment and production-like environments

For more details on how to use Doppler, see Doppler's readme file.

Start the stack in production mode:

doppler run -- docker compose -f docker-compose.prod.yml up

You can also run a single service (e.g., backend):

doppler run -- docker compose -f docker-compose.prod.yml build backend
doppler run -- docker compose -f docker-compose.prod.yml up backend

Note: Doppler injects secrets at runtime. Ensure you have Doppler CLI installed and configured with access to your project’s secrets.

Key Differences

• Environment Variables:
  • Dev: Uses .env files for local configuration.
  • Prod: Uses Doppler for secure secret injection.
• Compose Files:
  • Dev: docker-compose.dev.yml and pnpm scripts.
  • Prod: docker-compose.prod.yml (optimized for deployment, secure, persistent volumes)
• Usage:
  • Dev: Fast iteration, local testing.
  • Prod: Realistic environment, secure secrets, ready for deployment.

Add a new dependency to one of the packages

To add a new dependency to a specific package, use the following command from the repository root:

pnpm add <package-name> -w -F <package-folder>

or to add a dev dependency:

pnpm add <package-name> -w -D -F <package-folder>

You can also cd into the package folder and run the command without -F and -w flags.

Access the website online

The VigilArt development website is accessible at: https://dev.vigilart.app.
The production website is accessible at: https://vigilart.app.

The APIs are also accessible online by using dev-api.vigilart.app and api.vigilart.app respectively.

Documentation

Further documentation can be found in the documentation folder.

API documentation is auto-generated and can be accessed at different URLs based on your environment:

• Local development: http://localhost:3000/api/v1/docs
• Development environment: https://dev-api.vigilart.app/api/v1/docs
• Production environment: Not available.

The API documentation is generated using Swagger and provides detailed information about the available endpoints, request/response schemas, and authentication methods.

Developers

Yasmine BEDRANE	Sacha POLEROWICZ	Gianni HENRIQUES	Séphorah ANIAMBOSSOU