Skip to content

Latest commit

 

History

History
86 lines (57 loc) · 2.64 KB

README.md

File metadata and controls

86 lines (57 loc) · 2.64 KB
Raw

TechIsHiring Job Search Resources

A small app listing job search resources for tech professionals separated by category, providing key information as well as links to view the resource. Inspired by confs.tech (GitHub Repo)

Atomic Design

This project uses Atomic Design for it's Components. Here are several resources for Atomic Design if you are unfamiliar:

Adding a Job Search Resource

All the job search resources are located at the job search resources data repo as a json file. This file can be updated from the website or directly by creating a pull request to this file.

Job search resources have the following structure:

{
  "category_name": [
    {
      "name": "",
      "outline": "",
      "link": "",
      "description": "",
      "owner": "",
      "submitted_by": "",
      "submitted_on": "*date example: Mon, 29 Jul 2024 14:47:40 GMT*"
    }
  ]
}

While not preferred, new categories can be added when adding new resources. Please add a note as to why there needs to be a new category in the pull request being created.

Local development

Before running the app

Before the application can be used, you will need to fork the job search resources data repo and create a GitHub Personal Access Token before running the application.

Environment varialbes needs to also be set before running the application. Create a .env.local file in the root of the project and install these variables:

GITHUB_PAT=*GitHub Personal Access Token*
GITHUB_REPO_ADDRESS=*A repo address omitting GitHub's domain, i.e. /repos/techishiring/techishiring-website*
GITHUB_REPO_DATA_LOCATION=*Location of the data source, which is a json file, in the repo, i.e. /resource/data.json*

Running the app

To install the application:

npm ci

To run the application on a developement server:

npm run dev

Code linting

To check the code and styles quality, use the following command:

npm run lint

Production deployment

Run this command to build the project.

npm run build

Contributing

Check out the CONTRIBUTING.md guide to assist with all you need to know before getting started with making changes to the codebase.

License

MIT License