telcenter backend

• telcenter backend
  • Setup
  • How to Run
    • Development
    • Production
  • API Documentation
  • Usage
    • For Admins (Quản trị viên)
    • For User Accounts (Người dùng thuê bao)
  • License

Setup

Install dependencies:

cd $PROJECT_ROOT
npm i

Then, in project root, copy file .env.example into a new file called .env, and set appropriate values for those environment variables.

Next, setup the databases as required by those variables.

Finally, apply database schemas' migrations.

cd $PROJECT_ROOT
npx prisma migrate deploy

How to Run

Development

Run the development server:

npm run dev

Production

Build for production:

npm run build

Then, run production code:

npm run start

API Documentation

is available at ${BACKEND_URL}/docs.

For example if you are running on port 8000 at localhost:

http://localhost:8000/docs

Usage

For Admins (Quản trị viên)

Suppose that ${BACKEND_URL} is http://localhost:8000.

1. Register a new admin user at http://localhost:8000/admin/register using secret key (mã bí mật) admin.

2. Login with that new admin user.

3. ??

For User Accounts (Người dùng thuê bao)

License

Copyright (C) 2025 Vu Tung Lam et. al. Licensed under the terms of the 3-clause BSD license