Skip to content

Website Folders and Codes Documentation

Yudoong Y edited this page Jul 29, 2025 · 4 revisions

Project Overview

This document contains all necessary information about the technology stack, features, database schema, and implementation details. Future development should reference this document to maintain consistency.

Technology Stack

  • Frontend: Vue.js 3, TypeScript, Vue Router, Vuex/Pinia
  • Backend: Firebase
  • Authentication: Firebase

Core Features

  1. Event Management
    • Create and publish events
    • Event list display
    • Event details viewing
    • Search for events
    • Categorize events
  2. User System
    • User registration and login
    • Profile management
    • Achievements
  3. Interface Display
    • Mobile and Desktop web separate design
    • Modern UI interface
    • User-friendly navigation system

Project Structure

  • Frontend/
    • src/components/: Reusable view components
    • src/components/mobile: Mobile-version view components
    • src/views/: Page views
    • src/router/: Configurations of redirections within the website.
    • src/firebase/: Firebase configurations (keys) (You can forget it)
    • src/stores/: Some global storages (events, event revoke, tags, users)
    • src/assets/: CSS styles
    • src/types/: Declaration of Event and User types

Deployment Requirements

  • NPM install
  • .env (Environment variables configuration)

Development Guidelines

  • Remember to "npm install"
  • Download a .env, into Frontend/

Clone this wiki locally