https://github.com/egytech-fyi/egytech-fyi
The Frontend repo for egytech.fyi. egytech.fyi provides comprehensive data and statistics on participants in the tech industry. Easily retrieve information on job titles, experience levels, compensation, and more. Powered by Cloudflare Pages. 🚀
https://github.com/egytech-fyi/egytech-fyi
cloudflare-pages dashboard egyptian-programmers highcharts react typescript vitejs
Last synced: 6 months ago
JSON representation
The Frontend repo for egytech.fyi. egytech.fyi provides comprehensive data and statistics on participants in the tech industry. Easily retrieve information on job titles, experience levels, compensation, and more. Powered by Cloudflare Pages. 🚀
- Host: GitHub
- URL: https://github.com/egytech-fyi/egytech-fyi
- Owner: egytech-fyi
- Created: 2024-06-04T14:21:20.000Z (over 1 year ago)
- Default Branch: staging
- Last Pushed: 2024-09-22T14:10:28.000Z (about 1 year ago)
- Last Synced: 2025-04-10T03:54:58.247Z (6 months ago)
- Topics: cloudflare-pages, dashboard, egyptian-programmers, highcharts, react, typescript, vitejs
- Language: TypeScript
- Homepage:
- Size: 443 KB
- Stars: 144
- Watchers: 1
- Forks: 28
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# 🌟 EGYTECH.FYI Frontend
Welcome to the frontend repository for egytech.fyi, a dynamic dashboard and reporting tool that provides insights into the Egyptian Tech Scene. This application visualizes salary data and industry trends, akin to the Stack Overflow Developer Survey, enabling users to filter and analyze compensation within the tech sector in Egypt.
## 📋 Table of Contents
- [🌟 EGYTECH.FYI Frontend](#-egytechfyi-frontend)
- [📋 Table of Contents](#-table-of-contents)
- [🚀 Getting Started](#-getting-started)
- [🔧 Prerequisites](#-prerequisites)
- [📦 Installation](#-installation)
- [🖥️ Running the Application](#️-running-the-application)
- [🔍 Running Lint](#-running-lint)
- [👀 Previewing Build](#-previewing-build)
- [🎨 Features](#-features)
- [📚 Folder Structure](#-folder-structure)
- [🤝 Contributing](#-contributing)
- [Contributors](#contributors)
## 🚀 Getting Started
### 🔧 Prerequisites
Before you begin, ensure you have the following installed:
- [Node.js](https://nodejs.org/)
- [Yarn](https://yarnpkg.com/)
### 📦 Installation
To set up the project locally, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/your-username/egytech-fyi.git
cd egytech-fyi
```
2. Install dependencies:
```bash
yarn install
```
### 🖥️ Running the Application
Start the development server:
```bash
yarn dev
```
This will launch the Vite development server, making the application accessible at `http://localhost:3000`.
### 🔍 Running Lint
To ensure code quality and consistency, run ESLint with:
```bash
yarn lint
```
For best development, use these VS Code extensions:
- EditorConfig
- ESLint
- Prettier - Code formatter
### 👀 Previewing Build
To build the project and preview it locally:
```bash
yarn run build
yarn preview
```
## 🎨 Features
This dashboard includes:
- Interactive filters to view data based on job titles, experience levels, and technology stacks.
- Visual representations of salary ranges and distributions.
- Comparisons and analytical reports similar to industry surveys.
## 📚 Folder Structure
```javascript
└── 📁egytech-fyi
└── 📁.github
└── PULL_REQUEST_TEMPLATE.md
└── 📁.husky
└── pre-commit
└── pre-push
└── .prettierrc
└── 📁.vscode
└── settings.json
└── 📁public
└── 📁src
└── 📁assets
└── 📁components // for all the components used
└── 📁Shared // for shared agnostic components
└── 📁constants // for constants used across the repo
└── 📁context // for state contexts
└── 📁functions // for general functions
└── 📁mock //for mock data
└── 📁pages // for pages
└── 📁services // for api services
└── 📁styles // for style files (should follow the convention of .styles.scss)
└── 📁types // type script types
└── 📁utils // for utility functions
└── 📁Transformers // for data transformation functions
└── App.tsx
└── index.css
└── main.tsx
└── vite-env.d.ts
└── README.md
└── CONTRIBUTING.md
└── index.html
└── package.json
└── tsconfig.json
└── tsconfig.node.json
└── vite.config.ts
```
## 🤝 Contributing
Contributions are welcome! To help make this project better, please see the [CONTRIBUTING.md](CONTRIBUTING.md) file.
### Contributors
This project exists thanks to all the people who contribute. A special thanks to our key contributors:
- **Abdelrahman Eladawy**
- **GitHub:** [MrViometal](https://github.com/MrViometal)
- **LinkedIn:** [Abdelrahman Eladawy](https://www.linkedin.com/in/abdelrahman-el-adawy/)
- **Ahmed Eladawy**
- **LinkedIn:** [Ahmed Eladawy](https://www.linkedin.com/in/ahmed-eladawy-00b4a3115/)
- **Mahmoud Salem**
- **GitHub:** [mahsayedsalem](https://github.com/mahsayedsalem)
- **LinkedIn:** [mahsayedsalem](https://www.linkedin.com/in/mahsayedsalem/)
---
Visit the live application: [egytech.fyi](https://egytech.fyi)