4edb2f2b2c
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 <code@moiety.me> Co-committed-by: Zoë Bijl <code@moiety.me>
2.4 KiB
Contributing to Masto-FE (🦥 flavour)
Find an issue, code it up, all day long you'll have good luck!
Dependencies
To work on the code decently, you should have Node and Yarn installed. To avoid fuckery, Node Version Manager is highly recommended: https://github.com/nvm-sh/nvm.
Testing Locally
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
First get the GoToSocial repository cloned somewhere:
mkdir -p ~/go/src/codeberg.org/superseriousbusiness && \
cd ~/go/src/codeberg.org/superseriousbusiness && \
git clone git@codeberg.org:superseriousbusiness/gotosocial && \
cd ~/go/src/codeberg.org/superseriousbusiness/gotosocial
In the GtS repo directory, build GoToSocial with DEBUG=1 to enable the testrig:
DEBUG=1 ./scripts/build.sh
In the GtS repo directory, launch the GoToSocial testrig using the newly built binary, which will bind to port 8080 on localhost:
DEBUG=1 GTS_LOG_LEVEL=info ./gotosocial testrig start
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):
docker build -t superseriousbusiness/masto-fe-standalone:latest .
Deploy Masto-FE locally on port 3000:
docker run -it -p 3000:80 superseriousbusiness/masto-fe-standalone:latest
Open your browser and go to http://localhost:3000.
In the front page, enter http://localhost:8080 as your domain/instance. The http:// part is important, as without it Masto-FE will expect https!
Log in as email zork@example.org, password password, or admin@example.org, password password. You can now try posting stuff, viewing timelines, etc.
If you want to reset the testrig state, just stop it and launch it again. All database + storage state will be cleared when it stops, and repopulated when it launches. You will then need to log out of Masto-FE (🦥 flavour) and log back in again to reauthenticate.
Linting
Stuff needs to pass linting before it gets squerged:
yarn && yarn lint:js