josh-111111 v0.0.3

company-profiles-ui

Preview link

The project is a POC for Company Profiles page on the candidate side.

At the beginning we will be rolling the page out only for an agreed subset or companies, including SEEK itself, taking over the seek.com.au/companies/_id_/ home route.

For the initial stages, data will be hardcoded in the app and subsequently moved to appropriate databases as we grow bigger.

Note: there is NO intention to take over the company reviews as a product.

Existing company reviews set is treated as a set of third-party data providers and has a very little overlap with company profiles themselves.

This project is powered by sku, braid and built with React.

Getting Started

First of all, make sure you've installed Yarn.

Then, install dependencies:

$ yarn

Workflow

Setting up .env

getEnv script

You can configure your .env with the getEnv.sh script:

• Make sure your CLI is authenticated with AWS
  • e.g. use the awsauth tool
• Run yarn get-env

Manual steps

Configure your .env file with the following variables:

PAPI_KEY=
JOBS_API_KEY=
AUTH_API_KEY=

The values for these variables are considered secrets and are stored in AWS Secrets Manager. The .env file and its content should not be committed to the repo and therefore is inside .gitignore.

Note: You can use .env.sample as a guide by copying the content of it into your .env file and populating the values.

Make sure .env contains staging env variables.

Start a local development server:

$ yarn start

Then use this url to open SEEK profile in staging: https://dev.seek.com.au:3000/companies/seek-1217901. If you get SSL warning, then type: thisisunsafe.

By default, staging environment is used. If production environment is required then it can be specified (need to update .env file with prod values too):

$ yarn start --environment production

Then use this url to open SEEK profile in production: https://dev.seek.com.au:3000/companies/seek-432600.

Other commands

Run unit tests:

$ yarn test

Lint and format code:

$ yarn lint
$ yarn format

Build assets for deployment (staging/production):

$ yarn build