Cricket

Table of contents

• Welcome to Cricket!
• Getting Started
• Folder Structure
• Libraries
• Tools
• Attributions

Welcome to Cricket!

This repository contains all the bits related to the Cricket application hosted on GitHub Pages.

Cricket is a PWA (Progressive Web Application) that can be installed on any device through the browser.

Getting Started

Cloning the repository

First, clone the cricket-app repository:

# HTTPS
git clone https://github.com/lgaspari/cricket-app.git

# SSH
git clone git@github.com:lgaspari/cricket-app.git

Then, move to the folder:

cd cricket-app/

Installing the dependencies

This repository uses yarn for managing the project's packages:

yarn install  # or simply `yarn`

Running the application

Now, you should be able to start the application:

yarn start

After running the command above, the application should be opened automatically on your default browser, else you can do open it manually by clicking the following link: http://localhost:3000/cricket-app.

Deploy the application

Therefore, you can deploy the application (if needed) on GitHub Pages:

yarn deploy

The above command will take care of the following actions:

1. Cleaning up the build/ folder
2. Building the application
3. Deploying the application using the latest build

Tests

yarn test

Linter

yarn lint

Folder Structure

.
├── build/                  # Generated after running `yarn build`
├── node_modules/           # Generated after running `yarn install`
├── public/
│   ├── assets/
│   │   ├── audios/         # Cricket sounds
│   │   ├── icons/          # Favicon assets
│   │   └── images/         # Cricket images
│   ├── favicon.ico
│   ├── index.html
│   └── manifest.json
├── src/                    # Source code bits
│   ├── components/
│   └── index.tsx
├── .gitignore
├── package.json
├── README.md
├── tsconfig.json
└── yarn.lock

Libraries

• Deployment: gh-pages
• Linter: eslint
• Tests: @testing-library/react

Tools

• Assets generator: pwa-asset-generator
• Favicon generator: RealFaviconGenerator
• Folder structure generator: tree.nathanfriend.io
• SVG optimizations: SVGOMG

Attributions

• Insect Vectors by Vecteezy