From 4edb2f2b2cf53cb82b965dc7f57302362a827591 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zoe=CC=88=20Bijl?= Date: Tue, 30 Sep 2025 11:35:34 +0200 Subject: [PATCH] [docs] add documentation for `yarn dev` (#75) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added a few lines about running `yarn dev`. It’s easy enough to miss which port it runs on or whether it runs a server at all. Having this explicit URL should help. Reviewed-on: https://codeberg.org/superseriousbusiness/masto-fe-standalone/pulls/75 Co-authored-by: Zoë Bijl Co-committed-by: Zoë Bijl --- CONTRIBUTING.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f838cc333..2c5ea7f49 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,7 +8,14 @@ To work on the code decently, you should have Node and Yarn installed. To avoid ## Testing Locally -You can fairly easily test builds of Masto-FE locally by using Docker and the GoToSocial testrig. +If you want to run Masto-FE in dev mode: + +- install the project: `yarn install` +- start the dev server: `yarn dev` + +You should now be able to connect on http://localhost:3035. Changes will automatically compile. + +You can also fairly easily test builds of Masto-FE locally by using Docker and the GoToSocial testrig. ### Build GoToSocial + launch the GtS testrig @@ -37,7 +44,7 @@ Leave the testrig running. ### Build Masto-FE + run it locally -Now in a *separate* terminal window, get back to the Masto-FE directory, and do a Docker build (this might take a bit of time): +Now in a _separate_ terminal window, get back to the Masto-FE directory, and do a Docker build (this might take a bit of time): ```bash docker build -t superseriousbusiness/masto-fe-standalone:latest .