luisgulo/focalboard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update dev tips (#1504)

Browse source
This commit is contained in:
Chen-I Lim 2021-10-11 08:23:07 -07:00 committed by GitHub
parent 3faa053bc6
commit fd9b75a9d5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
website/site/content/contribute/getting-started/dev-tips.md
View file

@ -28,6 +28,20 @@ On Linux, to build the Linux app:
Clone the [GitHub repo here](https://github.com/mattermost/focalboard).
## Build and run from the terminal
Follow the steps in the [main readme file](https://github.com/mattermost/focalboard#building-the-server). In summary, to build and run the server:
```
make prebuild
make
./bin/focalboard-server
```
Then open a browser to `http://localhost:8000` to access it. The port is configured in `config.json`.
Once the server is running, you can rebuild just the webapp with `make webapp` (in a separate terminal window), then reload the browser.
## VSCode Setup
Here's a recommended dev-test loop using VSCode:
@ -79,4 +93,10 @@ Before checking-in commits, run: `make ci`, which is simlar to the ci.yml workfl
* Webapp unit tests: `cd webapp; npm run test`
* Webapp UI tests: `cd webapp; npm run cypress:ci`
## Running into problems or have questions?
If you run into any issues with the steps here, or have any general questions, please don't hesitate to reach out either on [GitHub](https://github.com/mattermost/focalboard) or our [Mattermost community channel](https://community.mattermost.com/core/channels/focalboard).
We welcome everyone, and appreciate any feedback.
glhf! :)