You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Before contributing to this specific repository, please read the [Contribution Guidelines](https://sofie-automation.github.io/sofie-core//docs/for-developers/contribution-guidelines) for the Sofie project.
3
+
Before contributing to this specific repository, please read the [Contribution Guidelines](https://sofie-automation.github.io/sofie-core/docs/for-developers/contribution-guidelines) for the Sofie project.
4
4
5
5
## Branches
6
6
@@ -10,4 +10,4 @@ This repository uses the following branches:
10
10
- The **_releaseXX_** branches are our in-development branches. When a release is ready, we decide to “freeze” that branch and create a new **_releaseXX+1_** branch.
11
11
12
12
We require contributions to be based based on the latest **_release\*_** branch.
13
-
The [_Sofie Releases_](https://sofie-automation.github.io/sofie-core//releases) page collects the status and timeline of the releases.
13
+
The [_Sofie Releases_](https://sofie-automation.github.io/sofie-core/releases) page collects the status and timeline of the releases.
Copy file name to clipboardExpand all lines: DEVELOPER.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,20 +6,20 @@ Before you start, be sure to read the [Contribution guidelines](CONTRIBUTING.md)
6
6
7
7
### Documentation
8
8
9
-
The documentation can be found at [Sofie TV Automation Documentation](https://sofie-automation.github.io/sofie-core//) and its for subsection [For Developers](https://sofie-automation.github.io/sofie-core//docs/for-developers/intro). Specific _Sofie Core_ information can also be in `DOCS.md` and `DEVELOPER.md` in the subfolders of this git project, for example [meteor/server/api/playout](meteor/server/api/playout/DOCS.md).
9
+
The documentation can be found at [Sofie TV Automation Documentation](https://sofie-automation.github.io/sofie-core/) and its for subsection [For Developers](https://sofie-automation.github.io/sofie-core/docs/for-developers/intro). Specific _Sofie Core_ information can also be in `DOCS.md` and `DEVELOPER.md` in the subfolders of this git project, for example [meteor/server/api/playout](meteor/server/api/playout/DOCS.md).
10
10
11
11
### Monorepo Layout
12
12
13
-
This repository is a monorepo and contains both the main application (usually called server-core) as well as multiple auxiliary projects. In the `meteor` folder you will find the main Meteor application with `server`and `client` sub folders for the server-side application and front end. The `packages` folder contains other libraries and apps used together with Sofie Core.
13
+
This repository is a monorepo and contains both the main application (usually called server-core) as well as multiple auxiliary projects. In the `meteor` folder you will find the main Meteor application with `server` for the server-side application. The `packages` folder contains the frontend, other libraries and apps used together with Sofie Core.
14
14
15
15
## Getting Started with Local Development
16
16
17
-
Follow these instructions to start up Sofie Core in development mode. (For production deploys, see [System documentation](https://sofie-automation.github.io/sofie-core//docs/user-guide/installation/intro).)
17
+
Follow these instructions to start up Sofie Core in development mode. (For production deploys, see [System documentation](https://sofie-automation.github.io/sofie-core/docs/user-guide/installation/intro).)
18
18
19
19
### Prerequisites
20
20
21
-
- Install [Node.js](https://nodejs.org)20 (using [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows) is the recommended way to install Node.js)
- Install [Node.js](https://nodejs.org)22 (using [nvm](https://github.com/nvm-sh/nvm) or [nvm-windows](https://github.com/coreybutler/nvm-windows) is the recommended way to install Node.js)
- Enable [corepack](https://nodejs.org/api/corepack.html#corepack) (`corepack enable`) as administrator/root. If `corepack` is not found, you may need to install it first with `npm install --global corepack`
24
24
25
25
- If on Windows, you may need to `npm install --global windows-build-tools` but this is not always necessary
@@ -72,7 +72,7 @@ The Sofie ui (served by Vite) can be accessed at `http://localhost:3005`. The me
72
72
73
73
### Lowering memory, CPU footprint in development
74
74
75
-
If you find yourself in a situation where running Sofie in development mode is too heavy, but you're not planning on modifying any of the low-level packages in the `packages` directory, you may want to run Sofie in the _UI-only mode_, in which only meteor will be rebuilt and type-checked on modification:
75
+
If you find yourself in a situation where running Sofie in development mode is too heavy, but you're not planning on modifying any of the low-level packages in the `packages` directory, you may want to run Sofie in the _UI-only mode_, in which only meteor and the ui will be rebuilt and type-checked on modification:
0 commit comments