Quick Start

A one page summary of how to get Recruitment Glossary up and running locally. This is required in order to add content to it.

Requirements

  • Git — latest source release
  • Node.js — latest LTS version or newer
Why Node.js? Recruitment Glossary uses npm (included with Node.js) to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts.

Cloning the Code

Firstly, you will need to use Git to clone the code for this repository down to your local machine. The code is hosted at a GitHub repo, and can be cloned with the following command:

git clone https://github.com/jamie-taylor-rjj/Recruitment-Glossary.git

This will copy all of the files from the GitHub repository down to your local machine, placing them in a RecruitmentGlossary directory.

git or gh?

There are (at the time of recording) two ways to clone a remote repository to your computer from GitHub:

  1. git
  2. gh

Both achieve the same thing, and either is preferred. gh is a newer (and GitHub only) way of interacting with repositories, but use whichever process you prefer.

Building & Running Locally

Installing Dependencies

In order to build the repository locally, you’ll first need to install all of the npm dependencies. This can be done by running the following command in the RecruitmentGlossary directory:

npm install
npm install Whenever you run this comment, npm (which is part of Node.js) will read through the package.json file and download all of the dependencies listed there. It will place all of the downloaded dependecies in the node_modules directory. Without the dependencies in this directory, the build and run commands will not work.

Running the WebApp

Once the install process completes, you can start the web application locally by running:

npm run start

This will start build the web application, and start a local web server. The web server will serve the built web application, and will be available at localhost:1313.

Help

If the above commands don’t work for you, first check the Troubleshooting page.

If the webapp still does not build locally, then please take a look at filing an issue in the GitHub repository for this project. However, please do check that you have installed the correct versions of the dependencies listed above before posting an issue.

Other commands

Doks (the theme that Recruitment Glossary is based on) comes with commands for common tasks. Technologies Used →

← Introduction
What is JavaScript? →