Development Documentation
  • Home
  • 🤝Contribution
    • Main
  • 🧰Toolbox
    • Model
    • Blocks
      • Guidelines
      • Discord
  • 2 v2
    • Main
Powered by GitBook
On this page
  • Milestone
  • Programming Language
  • Running & Building
  • Project Management
  • Custom Blocks
  • Links
  • Blocks Organisation
  • Create Components
  • Guidelines
  • Styling

Was this helpful?

Edit on GitHub
  1. 2 v2

Main

PreviousDiscord

Last updated 2 years ago

Was this helpful?

Milestone

Programming Language

Running & Building

package.json summary:

  • Run the Website : npm run dev

  • Build for Production : npm run build

  • Run the Preview (not much used) : npm run preview

Project Management

The goal of this new release is to keep the build time minimal and keep the project organized and easy to read. This piece of documentation will guide you through organizing the files and the project structure.

Custom Blocks

Links

Blocks Organisation

  • One file for each toolbox category

  • Name the file according to its category name

  • Blocks inside the file should be put in order of appearance in the toolbox

  • A comment must be put on top of each block definition

Create Components

Guidelines

  • Always comment your development

  • Try to make one component for one functionality (example: NavBar.vue only contains navbar code ; FNAF.vue only contains the fnaf game)

Styling

This is a release. No JavaScript - *.js file should populate it.

Custom blocks are using the

Vue components are created in the .

All the Global CSS styles or CSS classes used are in the directory

If a Vue component has too much styling you can create a CSS file for the component with the component's name inside the directory, then import it inside the component with @import './file_path' ()

TypeScript - .ts
TypeScript - *.ts
blockly 9 API
S4D Exemple Files
Blockly Custom Block API Documentation
components directory (src/components)
src/styles
src/styles
documentation