/Backend

🦄 The backend of UniCourse, an open-sourced modern course platform for students.

Primary LanguageTypeScriptMIT LicenseMIT


🦄 UniCourse Backend

🦄 UniCourse is an open-sourced modern course platform for students.

Tabel of Contents

Features

Course Search

UniCourse builds up a scalable system for three factors (course, teacher, provider) search.

Forum System

UniCourse provides a forum system for students to discuss about the topics related or unrelated to the courses, giving them a place to share their experience or ask for help.

Usage

Using Docker

We provide pre-built docker images, you can pull them from ghcr.io/unicourse-tw/backend.

However, you need to provide a .env and a database.

In the first time, you need to shape the database schema.

Example: Docker Compose 
# docker-compose.yml
version: "3.9"
name: UniCourse

services:
  backend:
    image: ghcr.io/unicourse-tw/backend:latest
    container_name: unicourse
    restart: unless-stopped
    ports:
      - "${BACKEND_PORT}:${BACKEND_PORT}"
    env_file:
      - .env
    depends_on:
      - db

  db:
    image: postgres:15-alpine
    container_name: unicourse-db
    restart: unless-stopped
    env_file:
      - .env
    expose:
      - 5432:5432
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data: {}

Contributing

You can find the contributing guidelines here.

License

UniCourse Backend is licensed under the MIT License.