@edenia/ui-kit

Eden UI Starter Kit

A frontend UI template for new projects to get started building on Eden on EOS quickly while maintaining consistency in visual design and styles with other eden tools.

Installation

Basic knowledge about Docker and NodeJS is required.

Getting started

Some things you need before getting started:

• git
• node.js
• docker

Running for the first time

• Clone this repo using git clone --depth=1 https://github.com/edenia/eden-UI-kit.git <YOUR_PROJECT_NAME>
• Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.
• Copy and rename the .env.example to .env then update the environment variables according to your needs

Quick start

At this point you can execute make run to execute distribute action locally.

File Structure

Within the project repository you will find the following directories and files:

eden-UI-kit/
├── src ..................... Project Source Code
| ├── config ................ Configuration Parameters
│ └── utils ................. EOSJS Utilities
├── package.json ............ NPM Project Metadata
├── yarn-lock.json .......... NPM Packages Lock File
├── .env.example ............ Environmental Variables Example File
├── .gitignore .............. Files Ignored by Git
├── Dockerfile .............. Docker Build 
├── LICENSE ................. MIT License Terms
└── README.md ............... Project Documentation

Contributing

Please Read EOS Costa Rica's Open Source Contributing Guidelines.

Please report bugs big and small by opening an issue

About Edenia

Edenia runs independent blockchain infrastructure and develops web3 solutions. Our team of technology-agnostic builders has been operating since 1987, leveraging the newest technologies to make the internet safer, more efficient, and more transparent.

edenia.com