Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/klaytn/countbapp
https://github.com/klaytn/countbapp
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/klaytn/countbapp
- Owner: klaytn
- License: mit
- Created: 2019-09-24T02:03:57.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T07:04:31.000Z (10 months ago)
- Last Synced: 2024-04-09T02:39:21.124Z (7 months ago)
- Language: JavaScript
- Homepage:
- Size: 5.73 MB
- Stars: 5
- Watchers: 13
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-klaytn - CountBApp - Simple counter web app interacting with a basic smart contract. (Sample Apps and Examples)
README
# CountBApp Tutorial
## Table of contents
- [1) Introduction](#1-introduction)
- [2) Getting started](#2-getting-started)
- [3) npm package information](#3-npm-package-information)
- [4) Directory Structure](#4-directory-structure)
- [5) Web browser support scope](#5-web-browser-support-scope)
- [6) License](#6-license)
- [7) Contributing](#7-contributing)
### 1) Introduction
CountBApp is intended to give a step by step guide to build a Klaytn BApp. No previous Klaytn experience is needed. We will make a simple web app interacting with a basic smart contract, `Count`.
Any user who has a Klaytn account can increase and decrease the current value as shown in the above gif.
> Full tutorial can be found in [Klaytn Docs_CountBApp](https://docs.klaytn.com/bapp/tutorials/count-bapp)
### 2) Getting started
1. Open terminal
2. Clone the repo by running `git clone https://github.com/klaytn/countbapp.git`
3. Run `npm install`to install node packages
4. Run `npm run local`
5. App should be running in https://localhost:8888
### 3) npm package information
> dependencies
```
The countbapp project is optimized for caver-js version "1.6.4".
caver-js needs confirmation before updating.
```
### 4) Directory Structure
> Folder structure
```
webpack.base.js // Base webpack settings
webpack.dev.js // Settings for local development
webpack.prod.js // Settings for build. (note: NODE_ENV= must be set to production)
dist // Files built with 'npm run build'
static // Contains static resources (index.html, images, font files etc...)
1. src
src - components // React components
src - klaytn // Klaytn related definition folder
index.js // Project build entry point.
index.scss // .scss file for index.js mentioned above.
```
### 5) Web browser support scope
> Supported browsers.
Chrome | Safari | Firefox | IE Edge*
---------------------- | ---------------------- | ---------------------- | ----------------------
Supported (Optimized) | Supported | Supported | Not supported
### 6) License
CountBApp is released under the [MIT license](./LICENSE).
```
MIT License
Copyright (c) 2018 CountBApp Authors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
```
### 7) Contributing
As an open source project, Klaytnwallet is always welcoming your contribution. Please read our [CONTTIBUTING.md](./CONTRIBUTING.md) for a walk-through of the contribution process.