Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 2.5 KB

readme.md

File metadata and controls

72 lines (52 loc) · 2.5 KB

GitHub release (latest by date)

codecov

CodeFactor

Progressive Web Application (PWA) build with React and Typescript to manage and display bets between two people. Store data in browser memory or connect to your own Firebase store.

Tech stack:

React Vite Tailwind Firebase Progressive Web Application

Usage - Quick Start

Stable version of application is hosted on GitHub Pages. To check how it looks like just open the running environment.

Local environment

  • Clone repository
    git clone https://github.com/radek2s/BetKeeper.git
    
  • Install dependencies for frontend application
    npm i
    
  • Run application (from root directory)
    npm run start
    
  • Open browser on address http://localhost:5173/

Firebase environment

To connect with firebase to store your bet data just create a new Firebase Application and provide all required configuration data directly on "Settings" page.

Development

Application was designed in Adobe XD. Then based on prepared mocup this application has been created.

Scripts

  • npm install: install project dependencies
  • npm prepare: install husky 🐶 - pre-commit hooks
  • npm start: Starts the application
  • npm test: Run Unit Tests
  • npm run build: Builds the application for production

PWA

To check the PWA application you must deploy that application on any HTTP server. For localhost you don't need to wory about SSL certificates. But for any other external server the SSL certificate must be valid and trusted and otherwise the application service worker will not start and the application will not work as PWA.

License

Images from unDraw
Icons from fluentIcons