Skip to content

Commit

Permalink
chore: readme changes (#57)
Browse files Browse the repository at this point in the history
  • Loading branch information
alvaroraminelli authored Nov 17, 2023
1 parent 57f7b8c commit 6d05911
Show file tree
Hide file tree
Showing 3 changed files with 1,009 additions and 989 deletions.
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,6 @@ testem.log
.DS_Store
Thumbs.db

.nx/cache
.nx/cache

package-lock.json
59 changes: 48 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,30 +11,67 @@ We just started; stay tuned for more to come!!! ☕️ 🔵

## Getting Started

More coming here
```sh
npx @base-org/build-onchain-apps@latest create <TEMPLATE_APP>
```

<p align='center'>
<img src='https://images.ctfassets.net/c5bd0wqjc7v0/3dFiAAcNU2DauF5zvakbA0/cc4bcc4621a12da40e6248b41e450844/cli.gif' width='600' alt='npm start'>
</p>

If you've previously installed `@base-org/build-onchain-apps` globally via `npm install -g @base-org/build-onchain-apps`, we recommend you uninstall the package using `npm uninstall -g @base-org/build-onchain-apps` or `yarn global remove @base-org/build-onchain-apps` to ensure that npx always uses the latest version.

_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_

## Contribution

We welcome contributions to Build Onchain Apps! ☕️ 🔵
To contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md).

## Develop
### Development

For all available scripts, check the [package.json](https://github.com/base-org/build-onchain-apps/blob/main/package.json), but if you don't know where to start, here are some useful ones.

```bash
# Install
git clone https://github.com/base-org/build-onchain-apps.git
cd build-onchain-apps
yarn
```

> Do not use npm to install the dependencies, as the specific package versions in `yarn.lock` are used to build and test build-onchain-apps.
To build the compiler and all the other modules included in the package:

```bash
yarn build
```

### Testing Locally

To test the package locally, use `npm link` to link the local package to the global npm registry.

# Format fix
```bash
yarn build
npm link
# Call CLI using the following command
build-onchain-apps create
```

# Format fix
yarn format
After you are done testing, you can unlink the package from the global npm registry.

# Lint fix
yarn lint
```bash
npm unlink @base-org/build-onchain-apps
```

## Contribution
### Adding new templates

We welcome contributions to Build Onchain Apps! ☕️ 🔵
To contribute, please see [CONTRIBUTING.md](CONTRIBUTING.md).
To make a new template, make a folder for it in the `templates` folder and set up your project there. Treat each template like its own Node.js project and run the commands in its folder.

```bash
cd templates/buy-me-a-coffee-app
yarn
yarn dev
```

## License

Expand Down
Loading

0 comments on commit 6d05911

Please sign in to comment.