Skip to content

muazhazali/cariair

Repository files navigation

CariAir

CariAir is a comprehensive web platform serving as Malaysia's definitive mineral and spring water source registry. The platform enables users to search, compare, and learn about various mineral water brands.

Tech Stack

Frontend Framework

  • Next.js 15 - React framework for production
  • React 19 - JavaScript library for building user interfaces
  • TypeScript - For type-safe code

Styling & UI

  • Tailwind CSS - Utility-first CSS framework
  • Radix UI - Unstyled, accessible components for building high‑quality design systems
  • Lucide React - Beautiful and consistent icon set
  • Embla Carousel - Extensible carousel/slider
  • Leaflet - Interactive maps library
  • Recharts - Composable charting library

Form Handling & Validation

  • React Hook Form - Performant forms with easy validation
  • Zod - TypeScript-first schema validation
  • Input OTP - One-time password input component

Development Tools

  • ESLint - Code linting
  • PostCSS - CSS transformation tool
  • next-themes - Theme management for Next.js

Getting Started

  1. Clone the repository:
git clone https://github.com/yourusername/cariair.git
cd cariair
  1. Install dependencies:
npm install
  1. Run the development server:
npm run dev
  1. Open http://localhost:3000 in your browser to see the application.

Available Scripts

  • npm run dev - Starts the development server
  • npm run build - Builds the app for production
  • npm start - Runs the built app in production mode
  • npm run lint - Runs ESLint to catch errors

Contributing

We welcome contributions to CariAir! Here's how you can help:

  1. Fork the repository
  2. Create your feature branch:
git checkout -b feature/AmazingFeature
  1. Commit your changes:
git commit -m 'Add some AmazingFeature'
  1. Push to the branch:
git push origin feature/AmazingFeature
  1. Open a Pull Request

Development Guidelines

  • Write clean, maintainable, and testable code
  • Follow TypeScript best practices
  • Ensure your code is properly formatted
  • Write meaningful commit messages
  • Update documentation as needed

About

CariAir is a comprehensive web platform serving as Malaysia's definitive mineral and spring water source registry

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors