Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
polarker committed Oct 15, 2024
1 parent a5a0c53 commit 1dae1e0
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
This is a Alephium template project for the
[Next.js](https://nextjs.org/) framework, it is bootstrapped with the
following command:
# Alephium Next.js Template

```
npx @alephium/cli init $project-name --template nextjs
```
This is a Alephium template project for the [Next.js](https://nextjs.org/) framework.

This template project demonstrates how to implement a simple token
faucet and expose it with a Web UI using Next.js.
Expand All @@ -20,14 +16,14 @@ npm install
### Start a local devnet for testing and development

```
npx @alephium/cli@latest devnet start
cd docker && docker compose up
```

### Deploy the token faucet contract

```bash
# In this case devnet
npx @alephium/cli deploy -n devnet
npm run devnet:deploy
```

This will compile and deploy the token faucet contracts to all of the
Expand All @@ -38,10 +34,10 @@ contracts first:

```bash
# Compile
npx @alephium/cli compile
npm run compile

# Test
npx @alephium/cli test
npm run test
```

### Run the development server
Expand All @@ -63,8 +59,8 @@ to interact with the application.
To learn more about smart contract development on Alephium, take a
look at the following resources:

- [Alephium Web3 SDK Guide](https://docs.alephium.org/dapps/alephium-web3/) - Learn about Alephium Web3 SDK
- [Ralph Language](https://docs.alephium.org/ralph/getting-started) - A guide to the Ralph programming language
- [Alephium Web3 SDK Guide](https://docs.alephium.org/sdk/getting-started/) - Learn about Alephium Web3 SDK
- [Ralph Language](https://docs.alephium.org/ralph/) - A guide to the Ralph programming language

You can check out the [Alephium GitHub
repositories](https://github.com/alephium) for more information - your
Expand Down

0 comments on commit 1dae1e0

Please sign in to comment.