Skip to content

Commit

Permalink
docs(#91): WIP changes to CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Tweekism committed Jul 16, 2024
1 parent 0460920 commit 8d17ebd
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 15 deletions.
57 changes: 50 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,60 @@ sure you follow the steps below:
- Make sure you are not adding any merge commits to your branch
- Open a pull request & wait for a review!🩵

## Developing environment
## Setting Up Your Build Environment

After installing all dependencies with `yarn`, you can run
### Build Requirements

To build Vivify you need the following dependencies:-

#### Arch Linux/Manjaro

```sh
yarn dev
sudo pacman -S --needed jq yarn make zip
```

to run the development server for Vivify on port 3000 that will (1)
automatically reload when you make changes to the code, and (2), unlike the
installed version, not shut down when there are no connected clients.
#### Fedora and derivatives

```sh
sudo dnf install jq yarn make zip
```

> [!TIP]
> TODO: Mention linux nodejs issue and refer to following section on nodejs
## Nodejs

***TODO: Talk about nodejs linux broken etc.***

## Building Vivify

***TODO: Take build steps from readme.md***

With the development server running, use
## Running Vivify for Development

Once you have built **Vivify** or installed it using the pre-built binaries, you
can then run the **Vivify** server in development mode to try it out with
live-updates as you are coding.

Using `yarn dev` to run **Vivify** in dev mode will:-

1. Run `vivify-server` on port `3000` instead of the usual port of `31622` so they
can be run side by side;
2. Automatically reload when you make changes to the code; and
3. Unlike the installed version, not shut down when there are no connected clients.

```sh
# Run yarn to update any nodejs / npm package depenencies
yarn

# Start the Vivify server in dev mode
yarn dev
```

With the development server running, use:-

```sh
# Connect an instance to your Vivify dev server
yarn viv
```

Expand All @@ -37,6 +76,10 @@ You can find files to test Vivify's rendering/parsing capabilities in the
[`tests/`](tests/) directory. Please make sure to add to this in case you add
anything new related to this.

## Troubleshooting

***TODO: Common errors and build problems here?***

## Writing Markdown

We use
Expand Down
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,14 +112,9 @@ directory as an argument! See below for installation options.
- run `./configure <install_dir>`
- run `make install`

> [!NOTE]
> Some Linux distributions package a version of Node.js that will fail to build Vivify. In that case you'll need to download an official version from https://nodejs.org/. The recommended method is to use [Node Version Manager (nvm)](https://github.com/nvm-sh/nvm/blob/master/README.md)
>
> ```
> curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
> exec bash
> nvm install node
> ```
> [!TIP]
> If you are having trouble building Vivify, or you'd like more detailed build
> instructions, see our [CONTRIBUTING](CONTRIBUTING.md) page
## Get help

Expand Down

0 comments on commit 8d17ebd

Please sign in to comment.