Skip to content

README.md

Latest commit

 

History

History
71 lines (49 loc) · 1.37 KB

README.md

File metadata and controls

71 lines (49 loc) · 1.37 KB

StellarAid Frontend

A modern React application built with Vite for the StellarAid platform.

🚀 Getting Started

Prerequisites

  • Node.js (v18 or higher)
  • npm or yarn

Installation

npm install

Development

npm run dev

The application will be available at http://localhost:5173

Build

npm run build

Preview Production Build

npm run preview

📁 Project Structure

src/
├── assets/          # Static assets (images, fonts, etc.)
├── components/      # Reusable components
│   ├── common/      # Common UI components
│   └── layout/      # Layout components
├── features/        # Feature-based modules
├── hooks/           # Custom React hooks
├── pages/           # Page components
├── routes/          # Routing configuration
├── services/        # API services and external integrations
├── store/           # State management
└── utils/           # Utility functions and helpers

🛠️ Tech Stack

  • React - UI library
  • Vite - Build tool and dev server
  • ESLint - Code linting

📝 Code Style

This project uses ESLint for code quality. Run linting with:

npm run lint

🤝 Contributing

Please follow the established folder structure and coding conventions when contributing to this project.