Skip to content

twetch-inc/docs

Repository files navigation

Getting Started

Requirements:

  • package manager, such as npm, yarn, pnpm or bun
  • node.js

Run yours.org locally:

  1. Download yours.org zipfile from github or clone.
    git clone https://github.com/yours-org/frontend.git
  2. Open filepath in shell or cmd:
    cd /frontend-master
  3. Run the development server:
    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
    # or
    bun dev
  4. Wait for start localhost and wait for compile to finish
  5. Open http://localhost:3000 with your browser to see the result.

Edit yours.org:

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

Component Library

This application uses a component library called shacdn. Components created using shacdn are saved in src/components/ui. To install new components please refer to their documentation

Design

Design mock ups are saved in the Yours Figma.

License

Yours.org is MIT licensed.