Klaystagram Project

Table of contents

• 1) Introduction
• 2) Getting started
• 3) npm package information
• 4) Directory Structure
• 5) Web browser support scope
• 6) License
• 7) Contributing

1) Introduction

Klaystagram is a practical BApp examples with complete source code and explanation. You can learn how to make Klaystagram, a Klaytn-based NFT photo licensing application.

Full tutorial can be found in Klaytn Docs_Klaystagram

2) Getting started

1. Open terminal
2. Clone the repo by running git clone https://github.com/klaytn/klaystagram.git
3. Run npm installto install node packages
4. Run npm run local
5. App should be running in https://localhost:8888

3) npm package information

dependencies

The klaystagram 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 - pages             // React page components (or containers)
src - components        // React components
src - constants         // Constants used throughout the project
src - klaytn            // Klaytn related definition folder
src - redux             // Redux settings (reducers, actions, store.js)
src - styles            // Style util files. Contains color, size, font info and etc. as well as Sass at-rules
src - utils             // Miscellaneous helper functions used throughout the source code
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

Klaystagram is released under the MIT license.

MIT License

Copyright (c) 2018 Klaystagram 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 for a walk-through of the contribution process.