Skip to content

Commit

Permalink
Merge pull request #10 from labscommunity/fix/workflows-dependencies
Browse files Browse the repository at this point in the history
fix: Install dependencies successfully in workflows
  • Loading branch information
pawanpaudel93 authored Oct 31, 2023
2 parents 964763b + 5b177bf commit 234dc70
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 44 deletions.
2 changes: 1 addition & 1 deletion .github/unlock-lock.sh
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
npx changeset version
npm i --package-lock-only
pnpm install
2 changes: 2 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ jobs:
id: changesets
uses: changesets/action@v1
with:
commit: "chore(release): version packages"
title: "chore(release): version packages"
version: .github/update-lock.sh
publish: npx changeset publish
env:
Expand Down
47 changes: 31 additions & 16 deletions apps/cli/template/next/common/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# StarterKit
# Arweave StarterKit

This is an Arweave Next.js project bootstrapped with [`create-arweave-app`](https://github.com/labscommunity/starterkit/tree/main/apps/cli).
Fast track your journey to building decentralized applications on Arweave with `create-arweave-app`. This CLI tool effortlessly sets up an entire application, harnessing the power of [NextJS](https://nextjs.org/) as the framework, [Shadcn UI](https://ui.shadcn.com/) for a sleek and aesthetic interface, and [ArweaveKit](https://arweavekit.com/?utm_source=Github&utm_medium=StarterKit+Repo&utm_campaign=Create-Arweave-App+StarterKit+Docs&utm_id=Create-Arweave-App+StarterKit+Docs) to seamlessly interact with the Arweave ecosystem.

## Getting Started

First, run the development server:
First, run the development:

```bash
npm run dev
Expand All @@ -16,23 +16,38 @@ pnpm dev
bun dev
```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
Open [http://localhost:3000](http://localhost:3000) in your browser to see the result.

You can start editing the page by modifying `app/page.tsx` or `pages/index.ts`.
**Landing Page:** A form that allows users to upload Atomic assets on Arweave, complete with various metadata configurations.

## Learn More
![Landing Page Form Preview](./public/landing-preview.png)

To learn more about [create-arweave-app](https://github.com/labscommunity/starterkit/blob/main/apps/cli/README.md), take a look at the following resources:
**View Page:** A dedicated space to view the uploaded assets and engage with them through on-chain likes (known as stamps) and comments.

- [Documentation](https://github.com/labscommunity/starterkit/blob/main/apps/cli/README.md)
![View Page Preview](./public/view-preview.png)

If you are not familiar with the different technologies used in this project, please refer to the respective docs.
Start editing the page by modifying `app/page.tsx` or `pages/index.ts`, as per your NextJS config.

- [Next.js](https://nextjs.org)
- [ArweaveKit](https://docs.arweavekit.com/arweavekit/introduction)
- [Arweave Wallet Kit](https://docs.arweavekit.com/wallets/wallet-kit)
- [Warp Contracts](https://docs.warp.cc/docs/sdk/overview)
- [Stamp Protocol](https://github.com/stamp-association/stamp/tree/main/packages/stampjs)
- [Shadcn UI](https://ui.shadcn.com/docs)
## Why use a StarterKit?

You can check out [create-arweave-app GitHub repository](https://github.com/labscommunity/starterkit) - your feedback and contributions are welcome!
Building DApps from scratch can be a daunting task. From setting up the environment to ensuring compatibility across different components, the process can be time-consuming. A scaffold provides a pre-configured foundation, enabling developers to focus on building unique features and functionalities rather than the underlying setup.

## What are the key components of the StarterKit?

- **Navbar:** A built-in navigation bar that integrates with [Arweave Wallet Kit](https://docs.arweavekit.com/wallets/wallet-kit?utm_source=Github&utm_medium=StarterKit+Repo&utm_campaign=Create-Arweave-App+StarterKit+Docs&utm_id=Create-Arweave-App+StarterKit+Docs), enabling users to connect to and interact with the DApp effortlessly.

- **Landing Page:** A landing page featuring a form, typesafed with [Zod](https://zod.dev/) schemas. Users can upload images and add metadata, which is then posted to the Arweave network as an [atomic asset](https://cookbook.arweave.dev/concepts/atomic-tokens.html).

- **Atomic Assets and Contracts:** Each asset is paired with an associated contract, enabling alterations to the metadata and transfer of ownership.

- **View Page:** A space to showcase assets and metadata, augmented with features like [Stamps](https://stamps.arweave.dev/#/en/main) (Arweave's version of 'likes') and [on-chain comments](https://specs.ar-io.dev/#/view/SYCrxZYzhP_L_iwmxS7niejyeJ_XhJtN4EArplCPHGQ).

## Leverage Modularity

The true strength of this kit lies in its modularity. Simply interchange the core asset from image to music and transform an image sharing application to a music hub. Or swap in for videos to create a streaming service. As any form of data can be uploaded to the Arweave network, the possibilities are limitless.

## Start Building

Ready to build your first application on Arweave? [Get started now!](https://github.com/labscommunity/starterkit/blob/main/apps/cli/README.md)

Checkout the [ArweaveKit docs](https://docs.arweavekit.com/arweavekit/introduction?utm_source=Github&utm_medium=StarterKit+Repo&utm_campaign=Create-Arweave-App+StarterKit+Docs&utm_id=Create-Arweave-App+StarterKit+Docs) to customize the application and add more features and follow us on [X](https://twitter.com/CommunityLabs) to stay updated on all things Arweave.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
"prettier": "^3.0.3",
"turbo": "latest"
},
"resolutions": {
"avsc": "github:Irys-xyz/avsc#a730cc8018b79e114b6a3381bbb57760a24c6cef"
},
"packageManager": "pnpm@8.6.10",
"name": "starterkit"
}
39 changes: 12 additions & 27 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 234dc70

Please sign in to comment.