Giter VIP home page Giter VIP logo

kaikas-tutorial's Introduction

Branch name will be changed

We will change the master branch to main on Dec 15, 2022. After the branch policy change, please check your local or forked repository settings.

Kaikas Tutorial

tutorial.kaikas.io

kaikas-tutorial-screen

1) Introduction

Kaikas Tutorial is a reference BApp that works with Kaikas. You can send Klaytn's various types of transactions in the Kaikas tutorial and refer to the source code to create your BApp.

2) Getting started

  1. Open terminal
  2. Clone the repo by running git clone https://github.com/klaytn/kaikas-tutorial.git
  3. cd kaikas-tutorial
  4. Run npm install to install node packages
  5. Run npm run local
  6. App should be running on https://localhost:8888

Builds the app for production

  1. Run npm run build to build app
  2. Run npm start
  3. App should be running on https://localhost:5555

3) npm package information

dependencies

The Kaikas Tutorial project is optimized for caver-js version "1.3.2".
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 - pages             // React page components
src - components        // React components
src - constants         // Constants used throughout the project
src - klaytn            // Klaytn related definition folder
src - styles            // Style util files. Contains color, size, font info and etc. as well as Sass at-rules
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

Kaikas Tutorial is released under the MIT license.

MIT License

Copyright (c) 2020 Kaikas Tutorial 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, Kaikas Tutorial is always welcoming your contribution. Please read our CONTTIBUTING.md for a walk-through of the contribution process.

kaikas-tutorial's People

Contributors

underbleu avatar elliothan avatar edwin082 avatar iv0rish avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.