jonlepage / web

APHGames Web

• 🎓 intended mainly for education at FIT CTU
• 📦 built on top of docusaurus library
• 🔥 slides and examples are built by using parcelJS pipeline

Project Structure

project
│
└───examples                // coding examples
│   │   assets              // assets that are copied into build folder
│   │   libs                // libraries for examples and demo projects
│   │   src                 // source files
│   │   view                // PUG templates that are bundled by Parcel
│   
└───scripts                 // scripts for pre-build, post-build, deployment etc.
│
└───slides                  // RevealJS-powered slides
│   │   assets              // assets (images, svg files, code snippets)
│   │   backgrounds         // background files for presentations
│   │   plugins             // RevealJS plugins
│   │   themes              // RevealJS themes (including APH theme for slides)
│   │   view                // PUG templates with all texts and declarations
│
└───wiki                    // docusaurus-powered wiki
│   │   blog                // place for a blog... not used right now
│   │   docs                // markdown documents with instructions, tutorials, guides etc.
│   │   plugins             // some plugins
│   │   src                 // React sources with custom components and themes
│   │   static              // static files (slides and examples are copied into this folder) 
│   │   types               // additional Typescript declarations
│
│   CHANGELOG.md            // changelog
│   package.json            // npm scripts and dependencies
│   README.md               // README file
│   tsconfig.json           // typescript config (only for pre-build)
│   tslint.json             // typescript linter settings for static checking

How to build this project

• clone it
• install nodeJS, LTS version if possible
• execute npm install
• if you want to build the examples, run npm run dev-examples and navigate to localhost:1234/index.html
• if you want to build the slides, run npm run dev-slides and navigate to localhost:1234/index.html
• if you want to build the wiki:
  • go to wiki folder
  • execute npm install
  • execute npm start and navigate to localhost:3000
• if you want to build everything
  • execute npm run deploy-all from the root folder. Everything gets bundled into build_wiki

Changelog is available here

Deployment

• the current version is deployed on aphgames.io