Project Scaffolding

Scaffoldin’? Aw yeeeah.

Project Directory

Become familiar with the project directory structure:

Screen shot of our project directory structure.

  1. Each project is a folder with the project short name
  2. After cloning a project from GitHub the project folder contains:
    • metadata.xlsb
    • README.md
  3. Next run start-project:
    • creates /dev/epub/ folder containing skeleton EPUBs for each volume listed in the metadata.xlsb file
    • creates package.json
    • creates projectdb.json
    • updates README.md
    • creates hidden files
      • .editorconfig
      • .gitattributes
      • .gitignore
  4. Next create a src folder inside the project folder
    • copy any source files from Trello or elsewhere to here
    • i.e. cover images, EPUBs, .docx files, inDesign files, PDFs etc.
  5. Each folder inside dev/epub/:
    • contains EPUB file structure
    • create EPUBs here following the Dev Process
  6. After EPUB passes the Review Process it is time to publish the project
    • running npm run build or npm run publish creates a dist folder including:
      • content_platform folder with CP EPUB(s) (npm run publish also uploads the EPUB(s) to Content Platform Processing Queue)
      • scene7 folder containing cover image(s) that need to be uploaded to Alfresco > Shared Files > Covers Database

Related Tools/Scripts

start-project (node)

  • Install globally with npm and use with every project (npm i -g @bhdirect/toolkit).
  • Usage info:
    • Clone your project repo.
    • cd into the project folder and enter start-project The script will prompt you for some info and return some important project information.
    • Create the src directory and add the source files to it.
Next