Topaz

get started by doing:

When running npm install you may get a big error, ignore it and run the following: npm i --legacy-peer-deps it's never good practice but it solves the issue :)

Framework7 CLI Options

Framework7 app created with following options:

{
  "cwd": "/Users/sammy/Documents/jailbreaks/Topaz",
  "type": [
    "web"
  ],
  "name": "Topaz",
  "framework": "svelte",
  "template": "tabs",
  "cssPreProcessor": false,
  "bundler": "vite",
  "theming": {
    "customColor": false,
    "color": "#007aff",
    "darkTheme": false,
    "iconFonts": true,
    "fillBars": false
  },
  "customBuild": false
}

Install Dependencies

First of all we need to install dependencies, run in terminal

npm install

NPM Scripts

• 🔥 start - run development server
• 🔧 dev - run development server
• 🔧 build - build web app for production

Vite

There is a Vite bundler setup. It compiles and bundles all "front-end" resources. You should work only with files located in /src folder. Vite config located in vite.config.js.

Assets

Assets (icons, splash screens) source images located in assets-src folder. To generate your own icons and splash screen images, you will need to replace all assets in this directory with your own images (pay attention to image size and format), and run the following command in the project directory:

framework7 assets

Or launch UI where you will be able to change icons and splash screens:

framework7 assets --ui

Documentation & Resources

• Framework7 Core Documentation

• Framework7 Svelte Documentation

• Framework7 Icons Reference

• Community Forum

Support Framework7

Love Framework7? Support project by donating or pledging on:

• Patreon: https://patreon.com/framework7
• OpenCollective: https://opencollective.com/framework7