πŸ“‚ Directory Structure

.
β”œβ”€β”€ ...
β”œβ”€β”€ packages                    # Monorepos
|   β”œβ”€β”€ client                  # The main code, web pages based on Nuxt.js
|   |   β”œβ”€β”€ assets              # Images, fonts, styles and other assets
|   |   β”œβ”€β”€ components          #⭐Vue components
|   |   β”œβ”€β”€ layouts             # Nuxt.js layouts
|   |   β”œβ”€β”€ middleware          # Nuxt.js routing middlewares
|   |   β”œβ”€β”€ mixins              # Vue mixins for code reuse
|   |   β”œβ”€β”€ pages               #⭐Nuxt.js pages, will be served with same directory structure
|   |   β”œβ”€β”€ plugins             # Nuxt.js plugins
|   |   β”œβ”€β”€ static              # Will be copied to root of the website
|   |   β”œβ”€β”€ store               #⭐Vuex store
|   |   β”œβ”€β”€ ...
|   |   └── nuxt.config.ts      # Nuxt.js config file
|   β”œβ”€β”€ core                    #⭐Core logic of BreadSplit, shared both client and server sides
|   β”œβ”€β”€ meta                    # Built-in data set
|   β”œβ”€β”€ firebase                #⭐Server functions and rules
|   β”œβ”€β”€ website                 # The introducation website
|   β”œβ”€β”€ types                   # Types definitions for Typescript
|   β”œβ”€β”€ locales                 #🌎i18n translations
|   β”œβ”€β”€ docs                    #πŸ“•For generating documentation website in the future
|   └── electron                #πŸ’»Electron build scripts and platform specify code
|
β”œβ”€β”€ test                        # Tests
|   β”œβ”€β”€ unit                    # Unit tests with Jest
|   └── cypress                 # End-to-end test Cypress
β”œβ”€β”€ scripts                     # Scripts helps to manage this project
β”œβ”€β”€ LICENSE
β”œβ”€β”€ ...
└── README.md

⭐: Important