Skip to content

Commit

Permalink
feat: initial commit
Browse files Browse the repository at this point in the history
release-as: 0.1.0
  • Loading branch information
hzhu committed Oct 1, 2023
0 parents commit 27207e0
Show file tree
Hide file tree
Showing 7 changed files with 1,330 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
on:
push:
branches:
- main
name: release-please
jobs:
release-please:
runs-on: ubuntu-latest
steps:
- uses: google-github-actions/release-please-action@v3
id: release
with:
release-type: node
package-name: test-release-please
# The logic below handles the npm publication:
- uses: actions/checkout@v3
# these if statements ensure that a publication only occurs when
# a new release is created:
if: ${{ steps.release.outputs.release_created }}
- uses: actions/setup-node@v3
with:
node-version: 18
registry-url: "https://registry.npmjs.org"
if: ${{ steps.release.outputs.release_created }}
- run: npm install
if: ${{ steps.release.outputs.release_created }}
- run: npm run build
if: ${{ steps.release.outputs.release_created }}
- run: npm publish --access public
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
if: ${{ steps.release.outputs.release_created }}
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules

dist
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# create-remix-dapp

[![npm version](https://img.shields.io/npm/v/create-remix-dapp.svg?logo=npm)](https://www.npmjs.com/package/create-remix-dapp)
[![build](https://github.com/hzhu/create-remix-dapp/actions/workflows/release-please.yml/badge.svg)](https://github.com/hzhu/create-remix-dapp/actions/workflows/release-please.yml)

## Overview

This CLI tool enables you to quickly start building a new [Remix](https://remix.run) dApp, with everything set up for you.

* Blockchain interaction with [viem](https://viem.sh) and [wagmi](https://wagmi.sh)
* [RainbowKit](https://www.rainbowkit.com) setup with [Sign-In with Ethereum](https://login.xyz)
* Internationalization and localization
* Styling with [tailwindcss](https://tailwindcss.com)
* Light and dark mode

## Quick Start

To bootstrap a Remix dApp run the following command in your terminal. This command will create a new app with the chosen name in the current directory.

```
npx create-remix-dapp@latest
```

## Contributing

The Remix starter dApp is hosted in a separate [GitHub repository](https://github.com/hzhu/remix-dapp). If you're looking to improve the Remix starter dApp, head over there.

0 comments on commit 27207e0

Please sign in to comment.