Giter VIP home page Giter VIP logo

transfer-coins's Introduction

Index

  1. About
  2. Installation
  3. TODO

About

This project (called Transfer Coins) is a web application built with Next.js and tested with Storybook.

Installation

The build has been tested with Node.js 19.2.0.

Husky

Husky, Prettier and ESLint is used to automatically test the local code before committing.

npm install -g prettier
npm install -g ESLint
npm run prepare

Storybook

Storybook is used to isolate and test UI components.

Run the Storybook server with:

npm run storybook
# or
yarn storybook
# or
pnpm storybook

Then, open http://localhost:6006 with your browser to see the result (or visit https://cjxe.github.io/transfer-coins/).

Next.js app

Run the Next.js server with:

npm run dev
# or
yarn dev
# or
pnpm dev

Then, open http://localhost:3000 with your browser to see the result.

TODO

High priority

  • new component: Data display > Text area

  • new component: Data display > Accordion

  • create /help

  • /help#FAQ

  • /help#contact

  • how to refactor navbar and footer?

    • 1 approach is to release the components as library
    • core elements go to /components/core meanwhile the templates/stories I create go to /components/templates
      • we don't want to import stories since stories test components in a specific state (source: Storybook docs)
  • Log in

  • Join now

    • Make ToS and PP a link (TextInput)
  • diger sayfalari da yap

  • add husky to workflow

  • add "disabled" state for components

  • use swiper to make "plan cards" a carousel

    • add Navigation and Pagination
  • use google analytics. official example

  • test useSession() works anywhere

  • create test API endpoint /protected and show email

  • create a middleware for checking every req if it has a token when accessing /dashboard

  • skip login/signup if user is already signed in

  • add new page: /legal

    • new page layout for content
      • /legal/terms-of-service
      • /legal/privacy-policy
        • link these to footer buttons
  • push changes

  • [ ]

  • make max width 1440px

New components

Data display
  • Table
    • make table responsive like Binance's
  • Chip
  • Alert
  • Loading s
  • Avatar
  • Tooltip
    • make FeatureContainers icons Tooltip
    • add href to icons in the list
  • Progress (low priority) s
  • KBD (low priority)
  • Notification Badge (very low priority)
Layout
  • Divider > Vertical/horizontal and w/ text in the middle
  • Notification/Toasts
    • fix: multiple toasts override each other. Make a list instead. Potential solution: bring up ToastContextProvider to <App /> and wrap it with <ToastListContextProvider>
Navigation
  • Navbar
    • make one for Logged in
  • Footer
  • Menu
    • Add Badges
  • Pagination
  • Table of Contents/Anchor s
  • Stepper (low priority)
  • Timeline (low priority)
  • Tabs (very low priority)
  • Breadcrumb (very low priority)
Actions/Data input
  • Button
  • Special button with icon
  • Checkbox
    • CheckboxList
  • ToggleSwitch
  • TextInput
    • add new child tag: FeedbackText
  • TextArea
  • File input
  • Dropdown
  • Modal also mobile like this
  • Radio (low priority)
    • RadioList
  • Range (very low priority)
  • Date picker (very low priority)
  • Rating i.e., 5 stars (very low priority)
  • Button group (very low priority)

Low priority

  • standardise all sizings to md

    • research result: -base variant is only applied to text styles. no flag (default one) is in between md and lg. However, for this project set the component size to md as if it's the base size
  • clean folder structure

    • will inner components have their parent name appended to the start?
    • will text compoennts have Text at the end? no
    • make all icon props start with a capital letter?
  • make all Icon propTypes: elementType (make sure there are no errors)

  • clean styles and use themes instead (this might help)

Components

  • refactor <FeatureContainer> (make it like <FeatureContainer.Heading> etc)
  • add new prop to <Accordion>: onlyOneIsOpen
  • add new sizes to <ToggleSwitch>: (sm, base, lg)
  • make <Checkbox> like <ToggleSwitch> where it gets checked even if the label is clicked
  • make new proprties for <Chip>: onClickIcon, onClick
  • Make <Avatar>s onError prop more seamingless (as soon as the image returns an error, broken-image icon is displayed and then gone after it is rerendered)
  • add new <Table> component with sorting
  • add new prop to <TextInput>: onResponse when text input has a text response

transfer-coins's People

Contributors

cjxe avatar

Stargazers

 avatar

Watchers

 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.