deeshansharma / github-jobs

A React JS app built using the GitHub Job API and Material-UI styling.

GitHub Jobs

A React JS app built using the GitHub Job API and Material-UI styling. You can search for your first or next job among all the listed jobs, use filters to narrow your results and be specific to what you are looking for.

This project is made for showcasing my work with API skills and using any styling library or framework. This project took me around four days to build, styling part took most time because I used Material UI for the first time.

Features

1. Fully responsive
2. Can apply different filters to narrow search results
3. Supports Dark and Light Mode, applies it as per the user's set preference on their device and can also switch it anyway
4. Takes advantage of React Hooks like 'useMemo, useEffect, useReducer' to re-render components when changed and this boosts performance

Built with

• Axios :- For interacting with the API.
• Markdown to JSX :- For converting received Markdown response into HTML.
• Material-UI { core, icons, lab } :- For styling the UI & UX.

Getting Started

These instructions will help you to setup your own copy of Github Jobs on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisite

• Git
• Yarn or NPM

NOTE: This guide follows Yarn as package manager because this app was built using Yarn. Steps for NPM would be quite similar but consider reading some guide.

Installation

1. Clone this repo

2. Install all the dependencies

   yarn

3. Tweak the code

4. Run on local server

   yarn start

Deployment

1. Create a new repo
2. Push your code to it
3. Create New Project on your Vercel Dashboard
4. Import your Git Repository
5. After successful import, changes made to the Production Branch (commonly "main/master") will be a Production Deployment and rest all branches will generate Preview Deployments.
6. Once deployed, you will get a URL for your live app, such as: https://xyz.vercel.app

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

License

Distributed under the MIT License. See LICENSE for more information.

Resources

• Axios Docs
• React JS Hooks Docs
• GitHub Jobs API Docs
• Material-UI Docs
• Deploy CRA using Vercel Article

NOTE: GitHub is closing its Jobs API so this app wont work after that (ref: Article), I already know this thing but still used this API because it was hard to get access to other APIs like Indeed, Freelancer, Upwork, etc. So, I had to use this.

Acknowledgement

• Freeboard/thingproxy :- Used for tackling CORS issue while development