diff --git a/docs/quick_start.mdx b/docs/quick_start.mdx index 3b6ee766..a79619c0 100644 --- a/docs/quick_start.mdx +++ b/docs/quick_start.mdx @@ -221,25 +221,58 @@ npm install -g electron firebase-tools dotenv-cli ## Run the Task -Running the task in development mode causes it to hot-reload whenever changes are made to the app. This is how you'll run the project while building your task. - -```shell title="Run the task in dev mode" +```shell title="Run the task in development mode" npm run dev ``` -This script launches an Electron window with the task and inspector open. +Running the task in development mode causes allows for hot-reloading whenever changes are made to the app. This is how you'll run the project while creating your task! + +:::tip +The dev script runs Honeycomb on Electron without any environment variables. Check out the [NPM Scripts](npm_scripts#dev) page for more information on the available development environments. +::: ## Edit the Task -Now that the task is up and running we can make our first changes to the code! We'll edit the `package.json` file to reflect your information. +Now that the project is up and running we can make our first changes to the code! + +### Edit the Project Metadata + +First we'll edit the `package.json` file so the project reflects your information. 1. Create a new branch ```shell - git checkout -b + git checkout -b edit-package-json ``` 2. Open `package.json` and edit it to reflect your app: + @@ -251,11 +257,45 @@ Now that the task is up and running we can make our first changes to the code! W +3. Save your changes and commit them to git: + + ```shell + git commit -m "edit package.json with my task's information" + ``` + +4. Create a [pull request](version_control#create-a-pull-request) to bring your changes into the `main` branch + +### Start Your Task + +Now we can start building our task! The `src` directory contains the main code for your task. The `src` directory contains the following files: +[More info about the folder structure] + +1. Return to the main branch + + ```shell + git checkout main + ``` + +1. Create a new branch + + ```shell + git checkout -b edit-package-json + ``` + +1. Open `package.json` and edit it to reflect your app: 1. `name` is your task's name, generally this is the name of our repository 2. `description` should be rewritten to better match your task @@ -248,13 +281,13 @@ Now that the task is up and running we can make our first changes to the code! W 5. `version` should be reset to 1.0.0 6. `repository` is the link the GitHub repository you created [earlier](#2-start-your-new-task-from-our-template-repository). -3. Save your changes and commit them to git: +1. Save your changes and commit them to git: ```shell - git commit -m "Commit message goes here!" + git commit -m "edit package.json with my task's information" ``` -4. Create a [pull request](version_control#create-a-pull-request) to bring your changes into the `main` branch +1. Create a [pull request](version_control#create-a-pull-request) to bring your changes into the `main` branch ## Next Steps