PlaceHires Admin Client

Production

https://admin.placehires.com

Staging

https://staging.admin.placehires.com

Developing

We're using Yarn instead of Npm here due to some issues

Prerequisites

• Environmental Variables:
  • You'll need correct variables defined in .env.development file
  • You'll also need NPM_TOKEN exported (~/.bashrc or whatever you use). This token should be your PAT with read:packages permission. See how to create a token here: https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token
• Server: navigate to backend repository

Starting development

$ yarn
$ yarn start

To view GraphQL schema and docs, go to http://localhost:3999/graphql

Developing Components

Styling solution

We use tss-react as a replacement for legacy @mui/styles (v4 styling solution)

Storybook

Isolate reusable components, and develop them using StoryBook. To run StoryBook, use the following command:

$ yarn storybook

You can read the guide in the introduction.

You can also view the latest live storybook here: https://develop--5febab14c80a270021a57c20.chromatic.com

GraphQL

Define GraphQL fragments and operations in src/apollo directory using .graphql files. Then use the following command:

$ yarn generate

This automatically generates types, documents, and hooks based on their name in src/generated/graphqlTypes.tsx.

For example a mutation:

mutation VerifyRecruiter($id: ID!) {
  verifyRecruiter(id: $id) {
    id
    verified
  }
}

generates useVerifyRecruiterMutation ready for use.

Formatting

We use Prettier to format our code:

$ yarn format