dappnode / DAppNodeDocs

Dappnode documentation
https://docs.dappnode.io
33 stars 49 forks source link

Tutorial of building a package from scratch #190

Open tropicar opened 2 years ago

tropicar commented 2 years ago

Create a tutorial which is useful to create packages and use the different features of dappnodesdk.

pablomendezroyo commented 11 months ago

@Marketen @dsimog01 @chuygarcia92 This one would be great to have it

dappnodedev commented 11 months ago

The steps would be:

  1. Run npx @dappnode/dappnodesdk@latest init and input the values you are prompted
  2. Know the difference between public and dnp packages (create a page for this in docs and add a link to it here)
  3. Have a look at the possibilities of the manifest (dappnode_package.json) and add all features you need to yours
  4. Create the setup-wizard.yml with all the params that need to be defined before package installation
  5. Create the docker-compose.yml file taking into account all the services that you need to include and the environment variables each one needs
  6. Recommendation: create a directory for each service and place there any files relevant to that service, like the Dockerfile or entrypoint.sh files
  7. Set up the CI if it applies. In case of the bump upstream action, you'll need to modify manifest, compose and Dockerfiles
Pol-Lanski commented 8 months ago

It should also include the video that @pablomendezroyo did: https://www.youtube.com/watch?v=KjsonhjX2eM