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.
Before you begin, ensure you have the following installed:
To set up the project locally, follow these steps:
-
Clone the repository:
git clone https://github.com/your-username/egytech-fyi.git cd egytech-fyi
-
Install dependencies:
yarn install
Start the development server:
yarn dev
This will launch the Vite development server, making the application accessible at http://localhost:3000
.
To ensure code quality and consistency, run ESLint with:
yarn lint
For best development, use these VS Code extensions:
- EditorConfig
- ESLint
- Prettier - Code formatter
To build the project and preview it locally:
yarn run build
yarn preview
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.
βββ π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 <FileName>.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
Contributions are welcome! To help make this project better, please see the CONTRIBUTING.md file.
This project exists thanks to all the people who contribute. A special thanks to our key contributors:
-
Abdelrahman Eladawy
- GitHub: MrViometal
- LinkedIn: Abdelrahman Eladawy
-
Ahmed Eladawy
- LinkedIn: Ahmed Eladawy
-
Mahmoud Salem
- GitHub: mahsayedsalem
- LinkedIn: mahsayedsalem
Visit the live application: egytech.fyi