Aqarni

Aqarni - Real Estate Portfolio Management Dashboard

A comprehensive dashboard for property investors in Dubai. Track investments, monitor performance, and make data-driven decisions.

Features

• Property portfolio management
• Investment tracking and analytics
• Document management
• Tenant management
• Automated reporting
• Interactive maps integration
• Payment processing

Tech Stack

• Next.js 14
• React 18
• TypeScript
• Tailwind CSS
• Radix UI
• Supabase
• Stripe
• Google Maps API

Prerequisites

• Node.js 18.x or later
• npm or pnpm
• Google Maps API key
• Supabase account
• Stripe account

Getting Started

1. Clone the repository:

   git clone https://github.com/yourusername/aqarni.git
   cd aqarni
   

2. Install dependencies:

   npm install
   # or
   pnpm install
   

3. Set up environment variables: Create a .env.local file in the root directory with the following variables:

   NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
   NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
   NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=your_google_maps_api_key
   STRIPE_SECRET_KEY=your_stripe_secret_key
   NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key
   

4. Run the development server:

   npm run dev
   # or
   pnpm dev
   

5. Open http://localhost:3000 in your browser.

Testing

Unit Tests

npm run test
# or
pnpm test

E2E Tests

npm run test:e2e
# or
pnpm test:e2e

Code Quality

Linting

npm run lint
# or
pnpm lint

Formatting

npm run format
# or
pnpm format

Project Structure

├── app/                # Next.js app directory
│   ├── api/           # API routes
│   ├── components/    # Shared components
│   ├── context/       # React context providers
│   └── dashboard/     # Dashboard pages
├── components/        # Global components
├── e2e/              # End-to-end tests
├── __tests__/        # Unit tests
├── lib/              # Utility functions
├── public/           # Static assets
└── styles/           # Global styles

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Commit Guidelines

We follow the Conventional Commits specification:

• feat: for new features
• fix: for bug fixes
• docs: for documentation changes
• style: for formatting changes
• refactor: for code refactoring
• test: for adding tests
• chore: for maintenance tasks

License

This project is licensed under the ISC License - see the LICENSE file for details.

Support

For support, email support@aqarni.com or join our Slack channel.