diff --git a/.gitignore b/.gitignore index 5353cf59..09fcf1a7 100644 --- a/.gitignore +++ b/.gitignore @@ -25,4 +25,4 @@ .vscode # Firebase -./firebase +.firebase diff --git a/docs/quick_start.mdx b/docs/quick_start.mdx index eda888f3..e5f8b500 100644 --- a/docs/quick_start.mdx +++ b/docs/quick_start.mdx @@ -22,17 +22,11 @@ The Honeycomb repository is a template and serves as the starting point for all 1. Go to the [Honeycomb repository](https://github.com/brown-ccv/honeycomb) 2. Click on `Use this template` and select `Create a new repository`. - Use this template + Use this template 3. Enter the owner, name, and description of your repository and click on `Create repository from template`. - Create the repository + Create the repository :::note We recommend creating a public repository and leaving `Include all branches` unchecked @@ -42,10 +36,7 @@ The Honeycomb repository is a template and serves as the starting point for all _`Settings -> Actions -> General -> Workflow permissions`_ - GitHub workflow permissions settings + GitHub workflow permissions settings _Additional details about template repositories can be found on the [Github Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)._ @@ -56,10 +47,7 @@ With the repository now setup it can be cloned onto your computer. 1. Navigate to the repository on [GitHub](https://github.com). 2. Click the `Code` button and copy the URL - GitHub clone repo button + GitHub clone repo button 3. Open a terminal and navigate to where you want the cloned directory @@ -120,10 +108,7 @@ See [Prerequisites](prerequisites) for more information about these programs. 1. Run Powershell as an admin from the start menu - Powershell admin launcher + Powershell admin launcher 2. Navigate to the root directory of your cloned repository 3. Paste the following command and follow the prompts to install the listed programs: @@ -171,28 +156,22 @@ NVM (Node Version Manager) is a tool for installing and using multiple versions 1. Install NVM - - + + The previous step installs{" "} - NVM for Windows via the winget - package manager. Note that this is a different tool than NVM with slight differences - needed for compatibility with Windows. + + NVM for Windows + {" "} + via the winget package manager. Note that this is a different tool + than NVM with slight differences needed for compatibility with + Windows. - + - curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash + curl -o- + https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.4/install.sh | bash @@ -231,7 +210,7 @@ npm install Certain Node dependencies are best installed globally. These tools will be available from the command line anywhere on your system. ```shell title="Install Honeycomb's global dependencies" -npm install -g electron firebase-tools dotenv-cli electron lint-staged +npm install -g electron firebase-tools dotenv-cli lint-staged ``` ## Run the Task @@ -386,7 +365,9 @@ The quick start guide details a [command line](version_control#git-commands) wor // ... export function buildTimeline(jsPsych, studyID, participantID) { - console.log(`Building timeline for participant ${participantID} on study ${studyID}`); + console.log( + `Building timeline for participant ${participantID} on study ${studyID}` + ); // highlight-delete-next-line const timeline = buildHoneycombTimeline(jsPsych);