The Permaweb Cookbook is designed to house concepts, guides, and small digestible code snippets for someone that has no experience with blockchain or the Permaweb to be able to learn from and build with.
The Cookbook is welcome to any and all contributions. Please refer to the project's style when contributing new snippets of code.
The main content for the cookbook is under the /src directory and split into
different sections.
These are the core concepts which underpin Arweave and the Permaweb.
These are structured guides for building on the Permaweb, which assume no prior knowledge of Arweave or AO.
These are specific examples on how to use different tools to accomplish tasks on the Permaweb, such as deployment, uploading data, etc. You can think of them as smaller recipes compared to guides.
References contain definitions and documentation for the Permaweb.
You need to have Node v16 installed. You can get the latest version at https://nodejs.org.
From the root directory, run:
npm install
npm run devwhich will install all relevant dependencies and start the local development server.
Learn more about translating the cookbook here.
If you find a tool or guide out of date, please create an issue on the project board so that it can be removed or updated.
We are using conventional commits for this repository.
To choose a task or make your own, do the following:
- Add an issue for the task and assign it to yourself or comment on the issue
- Make a draft PR referencing the issue.
The general flow for making a contribution:
- Fork the repo on GitHub
- Clone the project to your own machine
- Commit changes to your own branch
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
NOTE: Be sure to merge the latest from "upstream" before making a pull request!
You can find tasks on the project board or create an issue and assign it to yourself.
Happy Cooking!
touch wallet.json
# add wallet info
npm run deploy