Skip to content

README.md

Latest commit

 

History

History
121 lines (87 loc) · 3.73 KB

README.md

File metadata and controls

121 lines (87 loc) · 3.73 KB

Seven Burger

Seven Burger is a full-featured fast food delivery mobile app template.

Features

  • Products (dishes) catalog with filter by categories
  • Search products functionality
  • Save favorite products
  • Ability to add products to cart
  • Dynamically calculated cart
  • Supports both dark and light modes (auto-detection based on system preferences).
  • Supports both iOS and MD (Material Design) themes
  • Progressive Web App (PWA), app can be installed to the home screen, and uses service workers to cache all static assets.
  • State management with Framework7 built-in Store.
  • There are following screens (views) available:
    • Onboarding. Intro overlay to onboard new users.
    • Home (Catalog). Main page with:
      • search
      • categories filter
      • popular products section
      • trending products section
      • recent products section (displays recently viewed products)
    • Product Details. Page with detailed information about product, including:
      • image
      • title
      • subtitle
      • price
      • quantity selector
      • description
      • add to cart button
    • Favorites. Page with saved favorite products.
    • Cart (Order). Page with items added to cart and form to place and pay the order

Package

In the package you will find:

  • fully functional project created with Framework7 CLI (with Vite), with Framework7 Core version
  • well structured page and components files, coded in JSX syntax which can be easily ported to Framework7 React, Vue or Svelte
  • additional ESLint and Prettier setup
  • instructions on how to build, run and preview the project
  • all static demo data (mock products information and images)

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.

PWA

This is a PWA. Don't forget to check what is inside of your service-worker.js. It is also recommended that you disable service worker (or enable "Update on reload") in browser dev tools during development.

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

Connect to Git

It is possible to connect this project folder to the new repository. For example for GitHub:

  1. Create new GitHub repository at https://github.com/new

  2. Initialize Git. In terminal run:

    git init

  3. Add remote origin. Replace $USERNAME and $REPOSITORY with your GitHub username and newly created repository name:

    git remote add origin https://github.com/$USERNAME/$REPOSITORY.git

That is all, after that you can track, commit and push/pull to repo, for example:

git add .
git commit -m "initial commit"
git push origin master

Documentation & Resources

Support Framework7

Love Framework7? Support project by donating or pledging on:

mobileMenu

mobileMenu