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