Skip to content

INSTALLATION.md

Latest commit

 

History

History
104 lines (71 loc) · 2.56 KB

INSTALLATION.md

File metadata and controls

104 lines (71 loc) · 2.56 KB
Raw

← Back to Usage Guide Index

📦 Installation

Overview

M7BootStrap is distributed as plain JavaScript and can be dropped into any ES module–compatible environment. There’s no build process required — simply include the files in your project and import them.

1. Clone or Download

You can include M7BootStrap directly in your project by cloning the repository or downloading it as a ZIP.

# Clone repository
git clone https://github.com/linearblade/m7bootstrap.git

# Or download ZIP from GitHub and extract

Recommended project structure:

/vendor/
  m7Bootstrap/
    BootStrap.js
  m7Fetch/
    src/
      index.js

2. Install Dependencies

M7BootStrap requires m7Fetch for all package and asset fetching.

If using Git:

git clone https://github.com/linearblade/m7fetch.git vendor/m7Fetch

If downloading manually:

  • Place m7Fetch in your /vendor/ directory (or anywhere you prefer).
  • Ensure the relative import path in your code matches your folder layout.

3. Import into Your Project

//adjust as necessary if you split the source from your docs.
import Net from "./vendor/m7Fetch/src/index.js";
import BootStrap from "./vendor/m7Bootstrap/BootStrap.js";
import defaultLoadOpts   from "./vendor/m7BootStrap/src/defaults/defaultLoadOpts.js";
import defaultUnloadOpts from "./vendor/m7BootStrap/src/defaults/defaultUnloadOpts.js";


const net = new Net();
//no default options
//const bootstrap = new BootStrap(net);
//use the default options to get granular breakdown of whats going on.
const bootstrap = new BootStrap(net, {load: defaultLoadOpts, unload : defaultUnloadOpts} );

4. Verify Setup

Run a minimal test to confirm installation:

const report = await bootstrap.load('/vendor/m7BootStrap/examples/test/validateInstall/package.json',  {
    load: (sys, ctx) => console.log("Loaded:", ctx),
    error: (sys, ctx) => console.warn("Failed:", ctx)
  }
);

console.log("Boot status:", ok);

more advanced setup , if you wish to use a central repository, or define the repo package by package as necessary.

const loadReport = await bootstrap.load(
  [{ resource: "test/validateInstall/package.json", repo: ["/vendor/m7BootStrap/examples"] }],
    {
    load: (sys, ctx) => console.log("Loaded:", ctx),
    error: (sys, ctx) => console.warn("Failed:", ctx)
  }
);

If you see Loaded: [...] in the console, your installation is working.

Next Steps

Continue to Basic Concepts to learn the core ideas behind packages, repos, and handlers.