# @notree/server

> open source backend ecosystem for notree

Latest version **0.2.1** (published 2023-12-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @notree/server
pnpm add @notree/server
yarn add @notree/server
bun add @notree/server
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.1 |
| Published | 2023-12-19 |
| First published | 2023-07-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 9.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | notree-md |
| Maintainers | jollyjerr |

## Links

- npm: https://www.npmjs.com/package/@notree/server
- npm.io page: https://npm.io/package/@notree/server

## Dependencies (1)

- [@notree/common](https://npm.io/package/@notree/common.md) 0.2.0

## Recent versions

- 0.2.1 (latest) — 2023-12-19
- 0.2.0 — 2023-12-18
- 0.1.0 — 2023-07-11

## README

# Server

Open source backend ecosystem for notree

## Providers

### FileSystem

Reads a directory of markdown notes provided a path

```ts
const graph = await FileSystem.read({
  path: path.resolve(__dirname, 'your-directory'),
});
```

### GitHub

Reads a directory of markdown notes provided a GitHub repository.

Create a GitHub access token with read access to your repository. https://github.com/settings/tokens/new?scopes=repo

If you are developing locally, the test suite looks for your token in `.env` (at the root of the project) as `GITHUB_TOKEN`.

```ts
const graph = await GitHub.read({
  owner: 'you',
  repo: 'your-repository',
  basePath: 'optional/path/to/root',
  branch: 'defaults-to-main',
  token: process.env.GITHUB_TOKEN,
});
```

---
_Source: https://npm.io/package/@notree/server · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._