- React app with React Router, Tailwind, DaisyUI and Solana Wallet Adapter.
- Shared SDK
- cNFTs as a framework for handling documentation updates.
- Install node 20+ if you don't have it: https://nodejs.org/en
- Install pnpm if you don't have it:
npm i -g pnpm. - Install NX CLI if you don't have it:
pnpm i -g nx.
https://nx.dev/getting-started/intro
Start apps by running npx nx serve web.
To start the included React app run npx nx serve web.
Shared utilities across apps such as types and functions in ./packages/sdk.
Usage
import { mint } from "@dedoc/sdk"
View the available NX generators here. https://nx.dev/nx-api
To deploy the included apps on a platform like Railway, we use the following settings:
To deploy a static website like the React app, you can serve it like this.
Build Command
npx nx build web
Watch Paths
/apps/web
Start Command
npx http-server ./dist/apps/web
To deploy a Node app like the API, you can directly start it like this.
Build Command
npx nx build api
Watch Paths
/apps/api
Start Command
node ./dist/apps/api
When a new user visits DeDoc and signs in with their Solana wallet, they are greeted to create an account.
This does the following for a user:
- Creates a collection NFT that all
Projectswill sit under. - Sets up a config to allow for unlimited Projects to be added, for an extremely low cost of storage.
Follow this, a user is prompted to create a project. Here, you are able to maintain and update your Project as you do a normal documentation-base. The difference is, this one is completely held on-chain, with updates taking place through Metaplex's new update functionality for cNFTs.
After creating a project you can navigate into the editor, where you can make your changes and start building your documentation on-chain!
Here are a list of things DeDoc handles:
- Hosting for docs to be viewed by the public.
- Economic storage model to keep costs low for users.
- Ability to update docs in real time on-chain.
Not currently, but this is a feature we plan on adding in the future, and something we have set up early on to prepare for with existing users.
Yes, any user who creates an account and subsequent projects have full authority over those on-chain assets.
It's easier said than done, but looking at our preset model for creating, displaying, and updating pages should be thoroughly looked at if you plan on hosting your own version.
At the moment, there is no vendor cost for creating, storing, and uploading your documentation on-chain. However, you will be responsilble for paying the on-chain fees associated with the creation of any asset.
Join our server, Ru Labs, if you have any questions or need any support.
Assets are stored on Arweave and Solana. Arweave handles the JSON storage for your assets, while the Solana ledger maintains the history for your assets.
The most costly operation is creating an account, something you do 1 time per wallet, and this operation is .02 SOL ($2-3 at today's price). Updates and uploads only range in cost from a few cents.
Yes, you can follow our existing schema to import pages into DeDoc.
Since all data is on-chain and owned by the user, any loss of data by the user may be permanent and DeDoc is not held liable. You are allowed to back these files up in any way you see fit.