Skip to content

Commit

Permalink
docs(week-0): update README
Browse files Browse the repository at this point in the history
  • Loading branch information
yntpdotme committed Feb 12, 2024
1 parent 981a1ff commit 7a75d32
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 34 deletions.
81 changes: 47 additions & 34 deletions 0-1/assignments/week-0/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,44 @@

<a href="https://lighthouse-metrics.com/lighthouse/checks/8d118c63-e6ca-452f-8c9e-776f67c519f6/runs/47501c63-ef71-4f32-8466-123e6eb03379">
<p align=center>
<img width = "700px" alt="Jio Network blocking the view? Network switch reveals the magic!" src="./images/performance-metrics.JPG">
<img width = "700px" alt="Jio Network blocking the view? Network switch reveals the magic!" src="./images/performance.png">
<p>
</a>

<div align= "center">

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)&nbsp; [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
[![Twitter Badge](https://img.shields.io/badge/-@KadlagAkash-1ca0f1?style=flat&labelColor=1ca0f1&logo=twitter&logoColor=white&link=https://twitter.com/KadlagAkash)](https://twitter.com/KadlagAkash) &nbsp; [![Linkedin Badge](https://img.shields.io/badge/-KadlagAkash-0e76a8?style=flat&labelColor=0e76a8&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/kadlagakash/) &nbsp; [![Mail Badge](https://img.shields.io/badge/-akashkadlag14-c0392b?style=flat&labelColor=c0392b&logo=gmail&logoColor=white)](mailto:akashkadlag14@gmail.com) &nbsp; [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)&nbsp; [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)

</div>


<h2 align="center">

[🚀 Explore Demo](https://zerodha-landing-replica.vercel.app/) &nbsp;&nbsp;&nbsp; [📂 Source Code](https://github.com/KadlagAkash/zerodha-landing-replica)
[🚀&nbsp; Explore Demo](https://zerodha-landing-replica.vercel.app/) &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [📂&nbsp; Source Code](https://github.com/KadlagAkash/zerodha-landing-replica)

</h2>
<br>

<p align="center">
<a href="#introduction"><strong>Introduction</strong></a> ·
<a href="#features"><strong>Features</strong></a> ·
<a href="#tech-stack"><strong>Tech Stack</strong></a> ·
<a href="#development-setup"><strong>Development Setup</strong></a>
<a href="#introduction"><strong>Introduction</strong></a>
·&nbsp;<a href="#features"><strong>Features</strong></a>
·&nbsp;<a href="#tech-stack"><strong>Tech Stack</strong></a>
·&nbsp;<a href="#local-development"><strong>Development Setup</strong></a>
</p>
<br>

## Introduction
## <a name="introduction">❄️&nbsp; Introduction</a>

This project meticulously replicates the Zerodha website, crafted as part of Week-0's assignment for the 100xDevs Cohort by Harkirat Singh.
<br><br>

## Features
<a href="https://zerodha-landing-replica.vercel.app/">
<p align=center>
<img width = "550px" alt="Jio Network blocking the view? Network switch reveals the magic!" src="./images/zerodha-preview.png">
<p>
</a>
<br>

## <a name="features">🔋&nbsp; Features</a>

- **Modular CSS Design**: Maintainable and scalable styles.

- **Consistent Color Palette** and **Typography**: Ensuring visual harmony.
Expand All @@ -58,55 +65,61 @@ This project meticulously replicates the Zerodha website, crafted as part of Wee
- **Version Control with Git**: Efficient tracking and collaboration.

- **Efficient Development Workflow with Parcel**: Streamlining the development process.
<br><br>
<br><br>

## Tech Stack
## <a name="tech-stack">⚙️&nbsp; Tech Stack</a>

- [HTML5](https://developer.mozilla.org/en-US/docs/Web/HTML) – structuring
- [Modular CSS3](https://developer.mozilla.org/en-US/docs/Web/CSS) – CSS
- [Git](https://git-scm.com/) – versioning
- [Parcel](https://parceljs.org/) – building
- [AOS Library](https://michalsnik.github.io/aos/) – Animation Effects
- [Vercel](https://vercel.com/) – deployments
<br><br>
<br><br>

## <a name="local-development">🖥️&nbsp;&nbsp; Local Development</a>

## Development Setup
1. **Clone the repository:**
```bash
git clone [repository-url]
```

```bash
git clone https://github.com/KadlagAkash/zerodha-landing-replica.git
```

2. **Navigate to the project directory:**
```bash
cd zerodha-clone
```

```bash
cd zerodha-landing-replica
```

3. **Install dependencies:**
```bash
npm install
```

```bash
npm install
```

4. **Run the project:**
```bash
npm start
```

```bash
npm start
```

5. **Open your browser:**

Visit [http://localhost:1234](http://localhost:1234) to view the Zerodha Clone.
Visit [http://localhost:1234](http://localhost:1234) to view the Zerodha Clone.

6. **Build the project for production:**
```bash
npm run build
```
<br>
```bash
npm run build
```
<br>

## 📋&nbsp;&nbsp; Usage Instructions

## Usage Instructions
Simply navigate through the replicated Zerodha website to explore its features.
<br><br>

## Licensing Information
## 🪪&nbsp;&nbsp; Licensing Information

- This project is open-source and intended for learning purposes only.
- Please be aware that Zerodha, the original website's owner, may have legal rights over their intellectual property.
- It is crucial to use this project responsibly and refrain from any commercial or inappropriate use.
Binary file added 0-1/assignments/week-0/images/performance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7a75d32

Please sign in to comment.