Skip to content

Commit b56ec44

Browse files
docs: Added README.md file
1 parent 937a895 commit b56ec44

File tree

1 file changed

+71
-0
lines changed

1 file changed

+71
-0
lines changed

README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Tech Job Finder
2+
3+
Tech Job Finder is an Electron.js-based desktop application designed to help job seekers easily find and apply to tech companies worldwide. The app aggregates company information, including locations, websites, and services, making the job application process more streamlined and efficient.
4+
5+
## Features
6+
7+
- Browse a comprehensive list of tech companies.
8+
- Search and filter based on location and services.
9+
- Open company websites directly in the native browser.
10+
- Switch between table and card views for better readability.
11+
- Dark mode support for improved user experience.
12+
13+
## Getting Started
14+
15+
### Prerequisites
16+
17+
Ensure you have the following installed before proceeding:
18+
19+
- [Node.js](https://nodejs.org/)
20+
- [Git](https://git-scm.com/)
21+
22+
### Installation
23+
24+
1. **Clone the repository:**
25+
26+
```sh
27+
git clone https://github.com/MuhammedZohaib/GlobalTechJobs.git
28+
cd GlobalTechJobs
29+
```
30+
31+
2. **Install dependencies:**
32+
33+
```sh
34+
npm install
35+
```
36+
37+
3. **Run the application:**
38+
```sh
39+
npm start
40+
```
41+
42+
### Building the Application
43+
44+
To package the application into an executable file:
45+
46+
```sh
47+
npm run package
48+
```
49+
50+
The output will be available in the `dist/` directory.
51+
52+
## Support & Contributions
53+
54+
We welcome contributions to improve this project! If you have suggestions, bug reports, or feature requests, please open an issue or submit a pull request.
55+
56+
### How to Contribute
57+
58+
1. Fork the repository.
59+
2. Create a new branch (`git checkout -b feature-branch`).
60+
3. Commit your changes (`git commit -m 'Add new feature'`).
61+
4. Push to the branch (`git push origin feature-branch`).
62+
5. Open a Pull Request.
63+
64+
## Credits
65+
66+
- **Muhammad Zohaib**
67+
- **Muhammad Saad Suleman**
68+
69+
## License
70+
71+
This project is licensed under the [MIT License](LICENSE).

0 commit comments

Comments
 (0)