https://github.com/wpdas/create-alem-dapp
Create initial Além dApp bundle. Além is a web3 JavaScript / TypeScript library to create web3 apps for Near BOS.
https://github.com/wpdas/create-alem-dapp
alem app create dapp
Last synced: 4 months ago
JSON representation
Create initial Além dApp bundle. Além is a web3 JavaScript / TypeScript library to create web3 apps for Near BOS.
- Host: GitHub
- URL: https://github.com/wpdas/create-alem-dapp
- Owner: wpdas
- License: mit
- Created: 2024-03-05T23:23:36.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-16T21:59:18.000Z (about 1 year ago)
- Last Synced: 2025-01-13T01:11:43.943Z (6 months ago)
- Topics: alem, app, create, dapp
- Language: JavaScript
- Homepage: https://alem.dev
- Size: 69.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
- Roadmap: roadmap.md
Awesome Lists containing this project
README
# Create Alem DApp
Create dApps with no build configuration and deploy them to NEAR Bos (NEAR blockchain).
Get to know more about [**Alem Library**](https://github.com/wpdas/alem).
Create Alem dApp works on macOS, Windows, and Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask in the [Alem Discussions](https://t.me/alemlib/8).
## Quick Overview
```sh
npx create-alem-dapp my-app
cd my-app
npm start
```
If you want to use Typescript, you can use the typescript template like so:
```sh
npx create-alem-dapp my-app --template typescript
cd my-app
npm start
```
Or even using Tailwind:
```sh
npx create-alem-dapp my-app --template typescript-tailwind
cd my-app
npm start
```
## Creating an App
**You’ll need to have Node 18.0.0 or later version on your local development machine**. You can use [nvm](https://github.com/creationix/nvm#installation) (macOS/Linux) or [nvm-windows](https://github.com/coreybutler/nvm-windows#node-version-manager-nvm-for-windows) to switch Node versions between different projects.
To create a new app, you may choose one of the following methods:
### Npx
```sh
npx create-alem-dapp my-app
```
### Yarn
```sh
yarn create alem-dapp my-app
```
It will create a directory called `my-app` inside the current folder.
Inside that directory, it will generate the initial project structure and install the dependencies:
No configuration or complicated folder structures, only the files you need to build your app.
Once the installation is done, you can open your project folder:
```sh
cd my-app
```
Inside the newly created project, you can run some built-in commands:
### `npm start` or `yarn start`
Runs the app in development mode.
If it doesn't open automatically, open [http://localhost:8080](http://localhost:8080) or [http://127.0.0.1:8080](http://127.0.0.1:8080) to view it in the browser.
The page will automatically reload if you make changes to the code.
You will see the build errors and lint warnings in the console.
## Contributing
We'd love to have your helping hand on `create-alem-dapp`!
## License
Create Ale dApp is open source software [licensed as MIT](https://github.com/wpdas/create-alem-dapp/blob/main/LICENSE).