-
Notifications
You must be signed in to change notification settings - Fork 3
Project setup
- Git (installation instructions)
- Node (installation instructions)
- Yarn (installation instructions)
- Note: NPM (included with a Node installation) can also be used, but the instructions below assume the usage of Yarn.
- A GitHub account with access to this repo and, ideally, an SSH connection set up on your local machine
- See GitHub's documentation on setting up an SSH connection.
- You can also use HTTPS to clone, pull, and push, but you will have to always supply your GitHub username and password.
- The instructions below assume you have set up an SSH connection.
From the command line, in the directory into which you would like to download the project code, run git clone git@github.com:bcgov/workforce-profile-tool.git.
Change into the project directory (by default, workforce-profile-tool), and run yarn install. This will install all the project dependencies.
From the project directory, run yarn start to run a development environment. The project should open automatically in your browser; if it does not, navigate to localhost:3000 in a browser.
The project is a React app, bootstrapped with Create React App, so the instructions there might be helpful. Nearly every component is a functional component using hooks.
The project uses Typescript and a set of standard ESLint definitions, including prettier, to enforce code style and catch errors. If you edit the code using Visual Studio Code (recommended), the included settings file in /.vscode should help enforce these definitions whenever you save a file.
Most of the important components are in the /src/ directory. No data files are included locally, as they are loaded directly from the BC Data Catalogue.