Skip to content

Directory Structure

Directory Structure

bash
project
├── docker-compose
├── env
├── src
  ├── backend
  ├── config
  ├── config
  └── locales.ts
  ├── demo
  ├── typing
  ├── module
  ├── module-vendor
  ├── suite
  └── a-home
    ├── modules
  ├── home-base
  ├── home-index
  └── home-user
  └── suite-vendor

Module/Suite

NameDescription
src/moduleStandalone module (not part of a suite)
src/module-vendorStandalone module (from third-party)
src/suiteSuite
src/suite-vendorSuite (from third-party)

Development suggestions

Vona has planned the modules/suites so that we can start business development immediately in the specified directory. The following conventions are only suggestions and are not mandatory:

  1. Suite suite/a-demo: Contains some test or demo code, which can be disabled during build
  2. Suite suite/a-home: Development in this suite
  3. Grow into a large-scale system: As the business expands, more suites and modules can be created to split the system business

Directory cheat sheet

NameDescription
docker-composedocker-compose templates
envEnv
src/front/config/configConfig
src/front/config/locales.tsI18n
src/backend/demoDemo playground
src/backend/typingProject-level type definitions

Released under the MIT License.