Skip to content

Add a projects page that mentions local development #283

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
404Wolf wants to merge 1 commit into from
Closed

Add a projects page that mentions local development #283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/content/docs/projects/localdev.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Local Development
description: Edit your projects locally
sidebar:
order: 4
---

Val Town has an official command line tool for editing your val town projects locally, `vt`.

`vt` is much like git. With `vt`, you can clone a Val Town project, edit the project locally, and then push to Val Town. `vt` also has a watch command, which lets you sync a folder on your computer live with Val Town, so you can use your favorite local tools to edit the project, and automatically have changes propogate to the website.

For more information on `vt`, check out the [`vt` JSR page](https://jsr.io/@valtown/vt).
17 changes: 4 additions & 13 deletions src/content/docs/quickstarts/prompting.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,11 @@ You can also access Townie by clicking `Edit in Townie` in any val.

### Edit Projects with your Favorite IDE

#### Step 1: Setup
Use Val Town with your preferred IDE by first cloning your project locally with our [Val Town CLI](https://github.com/val-town/vt):
Use Val Town with your preferred IDE you can use [`vt`, the Val Town CLI](https://jsr.io/@valtown/vt).

``` bash
# Install CLI
deno install -gAfr jsr:@valtown/vt
To get started, install `vt` with `deno install -grAf jsr:@valtown/vt`, and then clone the project with `vt clone my-project`.

# Set API token
export VAL_TOWN_API_KEY=vtwn_replaceThis

# Clone project locally
vt clone my-project

```
Then, you can `cd my-project` to enter into the folder, and use `vt watch` to keep the folder synced with Val Town when changes are made locally.

#### Step 2: Add Val Town System Prompt
For each IDE, add our [system prompt](https://www.val.town/x/stevekrouse/OpenTownie/code/prompts/system_prompt.txt) as follows:
Expand All @@ -59,4 +50,4 @@ If things go wrong:
- **Complex changes?** Use [branches](../../projects/branches) and [merge](../../projects/pull-requests/) when stable
- **Code doesn't work?** Ask AI to debug the specific errors by copy and pasting, or screenshotting error messages

Not working? Get help on our [Discord](https://discord.val.town).
Not working? Get help on our [Discord](https://discord.val.town).