Brought to you by DeSci Labs and the DeSci OSS community.
Nodes is a tool for creating research objects - a type of verifiable scientific publication that combines manuscripts, code, data and more into a coherent unit of knowledge.
Nodes are published on a decentralized (“Open State”) repository that provides open content resolution, storage, provenance, data cataloguing, secure PIDs, and compute capabilities.
These resources will help you if you want to learn more (or join us on Discord):
Beta announcement post
User documentation
Learning materials
The best place to find the community is on the DeSci Labs Discord server. There you will find contributors working on various projects, the DeSci Labs team, scientists and researchers, Node Stewards, and other open-science enthusiasts. Come ask questions, test your ideas and projects, and get involved with the events we host every week!
Discord
Community Google Calendar
New contributors are very welcome!
We are actively building out resources for open source contributors. Check back often to see what's new!
The simplest ways to get involved are to:
- Make a PR, issue, or hit us up on Discord
- Submit a bug as an issue
- Submit a feature request as an issue
- Write and polish documentation
- Translate
DeSci Nodes is developed, maintained, and supported by DeSci Labs. Contributions and PRs are reviewed and approved by the DeSci Labs team. We are actively looking for contributors and projects to support, so get involved!
We would like to open up our task management software, let us know if interested in early access.
Houses all the tooling to build and deploy the ResearchObject contracts locally and for production. Includes a subgraph configuration for The Graph, which is run in a local Docker container and autodeploys your contract locally.
This is the React-based frontend for DeSci Nodes. It implements a Research Object viewer with support for editing and viewing IPLD-compliant JSON-LD self-describing linked data objects. It implements a frontend resolution of the dPID Resolution Scheme.
Note: This repo lives separately at https://github.com/desci-labs/nodes-web because it has a different open source license.
This is a NodeJS backend that helps Nodes with media transcoding videos to HLS using ffmpeg, and also helps run headless browser sessions to download PDFs and other free/fair-use media from the internet. It also implements an experimental LaTeX rendering service.
This is a Typescript types library that describes a spec for Research Objects. It has an internal representation used by nodes-web and desci-server and can marshal/unmarshal to JSON-LD to be self-describing.
This is a NodeJS backend that manages draft Nodes. It maintains a user auth, verifies wallet credentials, offers 2FA to users, and is the main system that orchestrates between microservices. It maintains version history for each update to Nodes. It interfaces with a Graph index to implement the DPID Resolution Scheme.
A library for programmatically interacting with Nodes, basically allowing automation of actions possible in the webapp. See separate documentation in the README.
A tiny service for proxying route segments to given target URL's, allowing hiding many target destinations under aliases on one domain. See docs in README.
Nobody knows why this is still here, but it implements a React+Three.js 3d torus that plays Conway's Game of Life on the surface of the torus. We were totally inspired by this gif on Wikipedia and it only seems to work on Mac/Linux right now, YMMV.
There is more information on each module within each folder's individual README.md.
The following guide is meant to get you running for full-stack dev on your local environment.
Make sure you have these packages installed on your system:
- Docker
- docker compose (comes with Docker Desktop, otherwise install the plugin package for your OS)
- lsof (may not be available by default depending on OS)
# Now run all services in Docker containers
./dockerDev.shThis starts:
- postgres (http://localhost:5433)
- desci-server (http://localhost:5420)
- ganache ledger (autodeploys ResearchObject + dPIDRegistry contract locally) (http://localhost:8545, metamask can connect to it locally)
- expedition explorer for local dev (http://localhost:3001)
- graph index pointing to latest deployed contract (http://localhost:8080)
- Local IPFS node (private, swarm key enabled) (http://localhost:5001 or http://localhost:8089)
- Local Ceramic node, run
bootstrapCeramic.shto initialize (http://localhost:7007)
Note: The Ceramic publish functionality needs to be activated by setting the corresponding environment variable, see .env.example for instructions.
Note: nodes-media (http://localhost:5454, responsible for DOI / PDF downloads, and for media transcoding) is disabled in the dev cluster by default, but can be uncommented in docker-compose.dev.yml for local development
Optional: Edit the DB, open http://localhost:5555
- Go to User table
- Edit user to have your email (or use the default user,
noreply@desci.com)
## 2.) Run frontend Follow the instructions in [`nodes-web`](https://github.com/desci-labs/nodes-web) and run the frontend.
Enjoy your local development setup of Nodes!
You may want to run VSCode server locally instead of using the default https://desci.dev to test VSCode extension development and other Nodes integrations with VSCode.
The recommended option is to use our code-server configuration
# in a separate dir
git clone https://github.com/desci-labs/code-server
# starts server on http://localhost:8085
./start.sh
# make sure you modify REACT_APP_CODE_SERVER in ../nodes-web/.env
Another option is to run run openvscode-server:
docker run -it --init -p 8085:3000 -v "$(pwd):/home/workspace:cached" gitpod/openvscode-server
Note: Modify desci-dapp/.env REACT_APP_VSCODE_DISABLE=1 to use old custom code viewer
Every Github push to develop will auto build + deploy to nodes-dev server cluster
- nodes-web is deployed to both Amplify and Vercel, depending on the branch
- desci-server is deployed to Kubernetes cluster via Github action