Nuistshare Backend

Powered by Nest.js, Prisma and PostgreSQL.

Description

Nuistshare is a platform for sharing resources in Nanjing University of Information Science and Technology, developed by Dustella

This is the backend part of Nuistshare. The frontend part is here.

Installation

Please make sure you have installed Node.js 16+. Recommanded is Node.js 20. The development environment is recommended to be VSCode.

$ pnpm install
# generate prisma client
$ pnpm prisma generate

Then, you should configure env correctly. The env file is .env.example. You should copy it to .env and fill in the correct values.

# .env
DATABASE_URL="postgresql://user:pass@url:5432/dbname?schema=public"
JWT_SECRET="114514"
MAIL_MAILER=smtp
MAIL_HOST=smtp.qcloudmail.com
MAIL_PORT=465
[email protected]
MAIL_PASSWORD=xxxx
MAIL_ENCRYPTION=ssl
[email protected]
MAIL_FROM_NAME=xxxx
QINIU_ACCESS_KEY='<Your Access Key>'
QINIU_SECRET_KEY='<Your Secret Key>'
QINIU_BUCKET='<Your Bucket Name>'

Development

You should have eslint plugin installed in your editor.

# development
$ pnpm dev
# lint
$ pnpm lint
# format
$ pnpm format

Build Docker Image

$ docker build -t nuistshare-backend .
# build docker

License

AGPL-3.0

Contribute

You can contribute to this project by opening issues or pull requests.
If you have any questions, please contact me by tg @dustella