/IPL_demo_app

Primary LanguageJavaScriptMIT LicenseMIT


IPL Demo App Logo

Search & Discover any IPL Details

Travis (.com) GitHub Twitter Follow

View Demo · Report Bug · Request Feature

Demo IPL Search App using Various Facet Filters like Players, Teams, Owners & Venus

✨ Features

  • Search Feature
  • Carousel
  • Trending News
  • Points Table
  • IPl 2021 Timetable
  • Upcoming Matches

Tech Stack

Stack - - - - -
FrontEnd


Reactjs


Javascript


Redux


Styled Components


Jest

BackEnd


Vercel

💨 Load Time

Google Chrome LightHouse in Private window : 5.1 s
First Contentful Paint : 1.1 s

🔥 Steps Taken to Reduce Load Time

  • Reduced Network Payload
  • Reduced Image Size
  • Can Use CSS Minifiers like PurgeCSS (Not Implemented)
  • Used Lazy Loading feature of React

🚀 Quick start

Start developing locally.

Step 1: Clone the repo

Fork the repository. then clone the repo locally by doing -

git clone https://github.com/helloshantanu/IPL_demo_app.git

Step 2: Install Dependencies

cd into the directory

cd IPL_demo_app

In the root folder do npm install.

npm install


### Step 3: Setup .env (optional)
To run the server you will also need to provide the `.env` variables

- create a new file .env in the root
- open [.env.EXAMPLE](./.env.EXAMPLE)
- copy the contents and paste it to the .env with valid keys

#### And you are good to go
```sh
npm run start

for a Build

npm run build

📂 What's inside?

A quick look at the folder structure of this project.

.
├── IPL_demo_app
|   ├─internals
|   ├─docs
|   ├─server
│   └─app
│     ├───components
│     ├───containers
│     ├───images
│     ├───tests
│     ├───translations
│     └───utils

✌️ Contributing

After cloning & setting up the local project you can push the changes to your github fork and make a pull request.

You can also run the tests locally to see if everything works fine with

Running tests

npm run test

Pushing the changes

git add .
git commit -m "feat: added new stuff"
git push YOUR_REPO_URL develop

Made with ❤️ and javascript & lot of Coffee!!

Screenshot