Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dao-xyz/peerbit-getting-started
Boilerplate project for Peerbit projects
https://github.com/dao-xyz/peerbit-getting-started
Last synced: 3 days ago
JSON representation
Boilerplate project for Peerbit projects
- Host: GitHub
- URL: https://github.com/dao-xyz/peerbit-getting-started
- Owner: dao-xyz
- Created: 2023-01-19T09:43:22.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T18:38:19.000Z (3 months ago)
- Last Synced: 2024-08-26T21:50:58.013Z (3 months ago)
- Language: TypeScript
- Size: 725 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Peerbit boilerplate project
This project contains a minimal configuration on how to use Peerbit and do testing with Jest.
Clone it to get started right away!
In [index.ts](./src/index.ts) we are creating a Database for text documents, which we try out in the [tests](./src/index.test.ts)
## Install
```sh
yarn install
```
(or use npm if you like)
## Test
```sh
yarn test
```
## Build
```sh
yarn build
```
# Getting started
To just play around with this project, clone in and open it in your favority editor.
Below the details of the project setup are explained.
# Documentation
Peerbit documentation can be found at [peerbit.org](https://peerbit.org)
## VS Code users
.vscode folder is included in this project
If you install the [Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest) (tested with v5.0.2 version of the extension) in VS Code, you can easily debug your tests, like this:
You can right click the green checkmark to get more debug options.