README.md

Além

Além is a web3 JavaScript / TypeScript library to create web3 apps for Near BOS.

Alem makes it painless to create interactive UIs. Design simple views for each state in your application. Declarative views make your code more predictable, simpler to understand, and easier to debug.

Build encapsulated components that manage their own state, then compose them to make complex UIs. Since component logic is written in JavaScript, you can easily pass rich data through your app.

Documentation - Learn how to use Alem in your project.

If you have questions or need help, please ask in the Alem Discussions.

Support Além

Installation

You’ll need to have Node 18.0.0 or later version on your local development machine. You can use nvm (macOS/Linux) or nvm-windows to switch Node versions between different projects.

Also, make sure you have Git installed on your machine.

Use the command below to start an initial boilerplate.

JavaScript

# Npx
npx create-alem-dapp my-app
cd my-app
npm start

# Yarn
yarn create alem-dapp my-app
cd my-app
yarn start

TypeScript

# Npx
npx create-alem-dapp my-app --template typescript
cd my-app
npm start

# Yarn
yarn create alem-dapp my-app --template typescript
cd my-app
yarn start

TypeScript with Tailwind

# Npx
npx create-alem-dapp my-app --template typescript-tailwind
cd my-app
npm start

# Yarn
yarn create alem-dapp my-app --template typescript-tailwind
cd my-app
yarn start

CLI

Além has its own command system. To use it, install Além globally.

# npm
npm install alem -g
# yarn
yarn global add alem

Get to know more about the CLI here.

Documentation

You can find the Alem documentation on the website.

Check out the Getting Started page for a quick overview.

Contributing

The main purpose of this repository is to continue evolving Alem core, making it faster and easier to use.

License

Alem is MIT licensed.