Skip to content

πŸ’° Seamlessly serving and visualizing interactive cryptocurrency data.

License

Notifications You must be signed in to change notification settings

zourdyzou/arkscapes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

89 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŽͺ Features

  • ⚑️ Webpack
  • βš›οΈ React
  • β›‘ TypeScript
  • πŸ“ ESLint β€” To find and fix problems in your code
  • πŸ’– Prettier β€” Code Formatter for consistent style
  • 🐢 Husky β€” For running scripts before committing
  • πŸš“ Commitlint β€” To make sure the commit messages follow the convention
  • πŸ–Œ Renovate β€” To keep the dependencies up to date
  • 🚫 lint-staged β€” Run ESLint and Prettier against staged Git files
  • πŸ‘· CI/CD - Deploy the application easily using Github Workflows
  • βš™οΈ EditorConfig - Consistent coding styles across editors and IDEs
  • πŸ—‚ Path Mapping β€” Import components or images using the @ prefix

πŸ“ Data Sources

The information and data used in Cryptoscapes is provided kindly by the following sources:

🎯 TODO: some of the things that needs to be working on.

  • Add internationalization features (🌏 Third-party? or file-based?)
  • Optimize bundling runtime, maybe Bun? (πŸ’‘ Good-to-go but not important)
  • SEO custom components, meta-data and json-ld (πŸ§ͺ SEO optimization on google ranking)
  • Image and Icon custom components that comply that WAI-ARIA convention
  • Web Accessibility pre-caution for DX (πŸ”° Quite a feat)

πŸ“œ Documentation

Requirements

  • Node.js >= 14.16.0

Directory Structure

  • .github β€” GitHub configuration including the CI workflow.
  • webpack β€” Webpack configuration and bundling rules to compile it as a static files.
  • test β€” Test rules and configuration: TDD.
  • public β€” Static assets such as robots.txt, images, and favicon.
  • src β€” Application source code, including pages, components, styles.

Scripts

  • yarn run dev β€” Starts the application in development mode at http://localhost:3000.
  • yarn run build β€” Creates an optimized production build of your application.
  • yarn run start β€” Starts the application in production mode.

Path Mapping

TypeScript are pre-configured with custom path mappings. To import components or files, use the @ prefix.

import { Button } from '@/components/Button';
// To import images or other files from the public folder
import avatar from '@/public/avatar.png';

Switch to Yarn/npm

This starter uses pnpm by default, but this choice is yours. If you'd like to switch to Yarn/npm, delete the yarn.lock file, install the dependencies with Yarn/npm, change the CI workflow, and Husky Git hooks to use Yarn/npm commands.

License

This project is licensed under the MIT License - see the LICENSE.md file for more information.

πŸŽƒ Recent Development Preview (Updated every 24-h)

Arkscapes-Cryptocurrency-Prices-Charts-and-Market-Overview