Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wighawag/jolly-roger
Build and Deploy for Eternity. Jolly Roger is a production-ready template for decentralised applications.
https://github.com/wighawag/jolly-roger
ethereum ipfs svelte
Last synced: 1 day ago
JSON representation
Build and Deploy for Eternity. Jolly Roger is a production-ready template for decentralised applications.
- Host: GitHub
- URL: https://github.com/wighawag/jolly-roger
- Owner: wighawag
- Created: 2020-04-21T09:27:27.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-05T19:44:03.000Z (4 months ago)
- Last Synced: 2024-03-19T04:33:19.000Z (4 months ago)
- Topics: ethereum, ipfs, svelte
- Language: TypeScript
- Homepage: https://jolly-roger.eth.limo
- Size: 6.47 MB
- Stars: 201
- Watchers: 14
- Forks: 30
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Lists
- awesome-svelte-kit - SvelteKit with Web3
- awesome-stars - wighawag/jolly-roger - Build and Deploy for Eternity. Jolly Roger is a production-ready template for decentralised applications. (TypeScript)
README
Jolly Roger
---
# Build and Deploy for Eternity
Jolly Roger is a production-ready template for decentralised applications.
# How to use?
We are assuming here that you already setup your env as specified in the [initial setup section](#initial-setup)
## install dependencies
Note here that while you can use `pnpm i`, we recommend you follow the instruction here so you can have everything setup with your own project's name.
```bash
pnpm boot
```
This will set the app name to the folder nane or the name you provide (and change the files to reflect that) and then call `pnpm i`
You can also manually set the name yourself :
```bash
pnpm set-name [] && pnpm i
```
## start!
Then Assuming you have [zellij](https://zellij.dev/) installed
```bash
pnpm start
```
**And you are ready to go!**
Note that if you do not have [zellij](https://zellij.dev/) (on windows for example) you can use [wezterm](https://wezfurlong.org/wezterm/index.html)
```bash
pnpm start:wezterm
```
Or you can also launch each component in their own process
```bash
pnpm local_node
```
```bash
pnpm contracts:compile:watch
```
```bash
pnpm contracts:deploy:watch
```
```bash
pnpm common:dev
```
```bash
pnpm indexer:dev
```
```bash
pnpm web:dev
```
# Deploying to a network
Just execute the following
```bash
pnpm contracts:deploy:prepare
```
and it will ask you few questions and get your .env.local setup with the var needed to deploy on the network of your choice.
You just need to have a endpoint url and mnemonic ready for it.
You can of course configure it manually with more option if you need
Then you can deploy your contract
```bash
pnpm contracts:deploy
```
And you can verify the contract
- on etherscan:
```bash
pnpm contracts:verify etherscan
```
- using sourcify:
```bash
pnpm contracts:verify sourcify
```
for etherscan if the network is not supported by default (no endpoint), you can provide your own:
```bash
pnpm contracts:verify etherscan --endpoint
```
# Initial Setup
You need to have these installed
- [nodejs](https://nodejs.org/en)
- [pnpm](https://pnpm.io/)
```bash
npm i -g pnpm
```
Then you need to install the local dependencies with the following command:
```bash
pnpm i
```
We also recommend to install [zellij](https://zellij.dev/) to have your dev env setup in one go via `pnpm start`