Install and Build

Learn how to install and build the Canyon Community Edition.

Configure Environment

Before starting the installation, you need to configure environment variables.

# Prisma Config
DATABASE_URL=postgress://canyon:canyon@localhost:5432/canyon

Clone the project

git clone https://github.com/canyon-project/canyon

Install dependencies and build the project

pnpm install && pnpm run build

Modify the .env file and create the database tables

pnpm run migrate

Run the project with Node.js

node packages/canyon-backend/dist/main.js

To run Canyon with Docker, simply specify the environment variable file path and port number

docker run -d -p 8080:8080 -v /your/path/.env:/app/.env zhangtao25/canyon:main

After a successful launch, there will be two main services:

Visit http://localhost:8000/login to log in to Canyon.