backend

Requirements

• Docker (optional)
• FaunaDB
• NATS Server

Windows

• NVM or Vanilla Node.JS
• WSL2
• PostgreSQL
• MongoDB
• Redis
• Prometheus
• IPFS Desktop (optional)
• IPFS CLI (optional)
• Chocolatey (optional, because of autoinstall script)
• Rust (optional, because of autoinstall script)
• Go (optional, because of autoinstall script)
• Pulumi (optional, because of autoinstall script)
• GCC (optional, because of autoinstall script)

MacOS

• MongoDB
• IPFS Desktop (optional)
• IPFS CLI (optional)

Linux

• MongoDB
• IPFS Desktop (optional)
• IPFS CLI (optional)

MacOS & Linux

• NVM or Vanilla Node.JS
• PostgreSQL
• Redis
• Prometheus
• Brew (optional, because of autoinstall script)
• Rust (optional, because of autoinstall script)
• Go (optional, because of autoinstall script)
• Pulumi (optional, because of autoinstall script)

Environmental variables

To successfully run project you have to set environmental variables in .env file.

POSTGRESQL_URL=postgresql://login:password@address:port/database?schema=databaseSchema
MONGODB_URL=mongodb+srv://login:password@address:port/database?retryWrites=true&w=majority
FAUNADB_KEY=key
FAUNADB_USERNAME=username
FAUNADB_PASSWORD=password
EMAIL=email
EMAIL_PASSWORD=password
AWS_ACCESS_KEY_ID=id
AWS_SECRET_ACCESS_KEY=key
DISCORD_TOKEN=token
DISCORD_SERVER_ID=id
REPLICATE_TOKEN=token
OPENAI_API_KEY=key
SERPAPI_API_KEY=key
VIRUS_TOTAL_API_KEY=key
REDIS_ADDRESS=redis://username:password@address:port

Commands

To install dependencies

yarn

or

just install

To install dependencies when you meet any problems with engine version

yarn --ignore-engines

To generate PostgreSQL database typescript

yarn run generate-postgresql-types

or

just generate-postgresql-types

To generate MongoDB database typescript

yarn run generate-mongodb-types

or

just generate-mongodb-types

To build production-ready project

yarn run build

or

just build

To run project

yarn run start

or

just start

To run command that builds project in development mode with hot reloading on save

yarn run dev

or

just dev

To run tests (unit & integration tests)

yarn run test

or

just test