Git Product home page Git Product logo

circuit-ui's Introduction

Circuits UI

Vaults

Read more about the Vaults program here.

Setup

Run the following command to setup the project:

sh ./initial-setup.sh (note : this uses yarn links in the submodules, may screw with symlinks if you're using them in another local repo)

This will pull the relevant git submodules, install dependencies, and build the submodules.

If you need to update any submodules, change directory to the submodule, pull the relevant changes, and then run yarn build to build the submodule.

Env File

add a .env.local file to be able to run the project locally. You can see example config in .env.example

Development

sh ./build_all_sm.sh - shortcut to build all submodules and dependencies. (note : this uses yarn links in the submodules, may screw with symlinks if you're using them in another local repo) yarn convert-icons - place any new icons in app/public/icons and run this command to convert them to React components. yarn build-vaults - use this command in the root directory to quickly build the Vaults TS SDK.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.tsx. The page auto-updates as you edit the file.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

circuit-ui's People

Contributors

chestersim avatar wphan avatar lukecaan 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.