Skip to content

Latest commit

 

History

History
25 lines (22 loc) · 2.04 KB

files-directories.md

File metadata and controls

25 lines (22 loc) · 2.04 KB

Files and directories

The following describes the files and directories used in the project.

  • build/: All the supporting files get compiled into this directory and this is what gets published. This should not be versioned.
  • config.json: Non-content config for application.
    • Use this to add non-local JS or CSS assets, such as from a CDN.
    • This can be overridden with a config.custom.json if there is a need to add configuration that should not be put into revision history.
  • content.json: This is the default way to manage content values. See the Application data section for more ways to hook up other data sources.
  • templates/: Holds HTML-like Svelte templates. Any files in here will get run through Svelte templating and passed values from the Application data, such as config.json, content.json, and package.json will be available.
    • pages/index.ejs.html: The default page for the application.
    • pages/_*.ejs.html: Includes for other templates.
    • pages/*.ejs.html: Any templates without a _ prefix will be rendered into an full HTML page.
  • styles/: Styles in SASS syntax.
    • styles/index.scss: Main point of entry for styles.
    • styles/_*.scss: Any includes should be prefixed with an underscore.
  • app/: Where JS logic goes. This supports ES6+ JS syntax with Babel and gets compiled with Webpack.
    • app/index.js: Main entry point of application.
  • assets/: Various media files. This gets copied directly to the build.
  • sources/: Directory is for all non-data source material, such as wireframes or original images. Note that if there are materials that should not be made public, consider using Dropbox and make a note in this file about how to access, and make sure to update the .gitignore file.
  • lib/: Modules used in building or other non-data tasks.
  • tests/: Tests for app; see Testing section below.
  • docs/: Holds documentation files.

Other files are for configuration or meta-information.