README.md

March 16, 2020 ยท View on GitHub

Npm version CircleCI Documentation Maintenance Dependencies DevDependencies License: MIT

Welcome to bento-starter :wave:

Bento-starter


:bento: bento-starter is an Open-Source Full-Stack solution that helps you to build fast and maintainable web applications using tools like Vue.js, Firebase, Progressive Web Apps support, dynamic offline support... The goal of this project is to provide a powerful and well configured stack (with CI/CD, hosting...) so you can focus on writing your web application very quickly.

As this project is a template project and not a CLI, you have access to the entire app configuration so you can change it according to your needs.

:book: Documentation

Want to setup this stack ?

:point_right: The full documentation is available here

Demo

:point_right: https://bento-starter.firebaseapp.com

Install the PWA demo from Google Play Store :point_right: bento-starter Google Play Store


demo


Lighthouse score :

Lighthouse score

Optional preconfigured Github Actions workflow :

  • :heavy_check_mark: Check tests and quality
  • :gear: Build the project
  • :rocket: Deploy to firebase hosting

The stack is made up of :

  • :metal: Vue.js : front-end framework
  • :wrench: Vue-cli : standard tooling for vue.js development
  • :repeat: Vuex : state management
  • :floppy_disk: Firestore : cloud NoSQL Database
  • :house: Firebase hosting : fast and secure web hosting
  • :bust_in_silhouette: Firebase authentication : for easy authentication
  • :iphone: PWA : progressive web app support
  • :lipstick: Prettier : code formatting rules
  • :rotating_light: Eslint : control code quality
  • :white_check_mark: Jest : unit testing
  • :white_check_mark: Cypress : e2e testing
  • :mag: Vue head : meta description per page
  • :page_facing_up: [Optional]prerender spa plugin : pages prerendering
  • :green_heart: [Optional]circleci : continuous integration/deployment
  • :package: [Optional]bundlesize : control your js bundles sizes

App embedded features :

  • :bust_in_silhouette: Google authentication
  • :mobile_phone_off: Offline support (dynamic & static caching)
  • :new: New version available prompt on new app deployments
  • :heavy_plus_sign: Add to home screen prompt for ios & android
  • :leftwards_arrow_with_hook: Smart redirection for auth protected routes
  • :sparkles: Products page example to demonstrate app data management with firestore and vuex
  • :muscle: Better PWA support for all browsers with PWACompat

โœจ Contributors

Thomas Betous
Thomas Betous

๐Ÿ’ป ๐Ÿ“– ๐Ÿ’ฌ ๐Ÿค” ๐Ÿ‘€ ๐Ÿšง
Franck Abgrall
Franck Abgrall

๐Ÿ’ป ๐Ÿ“– ๐Ÿ’ฌ ๐Ÿค” ๐Ÿ‘€ ๐Ÿšง
Thibaud Courtoison
Thibaud Courtoison

๐Ÿ“–
Mathias Bernardeau
Mathias Bernardeau

๐Ÿ’ป ๐Ÿค”
James Perkins
James Perkins

๐Ÿ’ป ๐Ÿ› ๐Ÿ’ฌ
Antoine CELLIER
Antoine CELLIER

๐Ÿ’ป
0xflotus
0xflotus

๐Ÿ“–
Gr3gory B3van
Gr3gory B3van

๐Ÿค”
Roy Bakker
Roy Bakker

๐Ÿ›
Adam Bar
Adam Bar

๐Ÿค”
Chidindu Ogbonna
Chidindu Ogbonna

๐Ÿ’ป
Vincent Bourdeau
Vincent Bourdeau

๐Ÿ’ป

Show your support

โญ๏ธ this repo

๐Ÿ’ฌ Chat

Want to chat with us ? ๐Ÿ‘‰ join bento-starter slack

License

This project is MIT licensed.