🎪 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:

• CoinGecko
• ETH Gas Station
• Alternative.me
• Blockchain.com

🎯 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)