Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

strict-dev/lumx-nft-collection

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

74 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stargazers MIT License


Lumx NFT

This app was made for Lumx Studio's - Frontend Developer Challenge, it's an NFT Collection dashboard to visualize the collection info and market data.

View Live

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. License
  6. Contact

About the development process

The project was made using the following tools and standards for good development experience and good code quality:

  • Commitlint to check the commit message following Angular's style.
  • lint-staged to ensure no lint or TypeScript errors were committed.
  • Prettier to format the code following the ESlint Standard.

Note 1: Although it not followed gitflow, I tried to follow the best practices for git commits.

Note 2: Tests were also not fully implemented because that would demand much time, so only snapshots were made for the components.

App demo Lumx NFT

(back to top)

Built With

(back to top)

Getting Started

Vercel Deploy

Storybook Deploy

Prerequisites

This project use pnpm as package manager.

Installation

  1. Clone the repo
    git clone https://github.com/strict-dev/lumx-nft-collection
  2. Install NPM packages
    pnpm install
  3. run dev server
    pnpm dev
  4. Running the Storybook server
    pnpm storybook

(back to top)

Roadmap

  • Components

    • Collection Info
    • Header
    • Hyper Trend
    • Loader
    • Period Selector
    • Sales card
  • Pages (this is a SPA application 😅)

    • Home
  • Api

    • /api/collection (get collection info)

    Note: Nextjs api route to fetch mocked data to simulate a real api

Issues

  • There's some Layout shift when the page is loaded, this is because the page is rendered with Loader skeleton component that need some refinement on the layout. It's affects the CLS Web Vitals score.

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

(back to top)