Skip to content

README.md

Latest commit

 

History

History
128 lines (90 loc) · 2.68 KB

README.md

File metadata and controls

128 lines (90 loc) · 2.68 KB

Xilancer

A Flutter-based freelancing platform application.

About

Xilancer is a comprehensive freelancing marketplace that connects clients with freelancers for various projects and services. Built with Flutter, it provides a seamless experience across mobile platforms.

Features

  • User authentication (sign up, sign in, password reset)
  • Project posting and management
  • Freelancer profiles with skills and portfolios
  • Proposal submission and management
  • Order tracking and milestone-based payments
  • Wallet system for financial transactions
  • Subscription plans for premium features
  • Notification system
  • Support ticket management

Tech Stack

  • Frontend: Flutter (Dart)
  • State Management: Provider/MVVM pattern
  • Backend: REST API (assumed)
  • Database: (assumed)

Project Structure

lib/
├── view_models/     # Business logic and state management
├── views/           # UI components and screens
├── components/      # Reusable UI components
├── utils/           # Helper functions and utilities
└── constants/       # Application constants

Getting Started

Prerequisites

  • Flutter SDK (stable channel)
  • Android Studio (for Android development)
  • Xcode (for iOS development on macOS)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/xilancer.git

  2. Navigate to the project directory:

    cd xilancer

  3. Install dependencies:

    flutter pub get

Running the App

  • For Android:

    flutter run -d android

  • For iOS:

    flutter run -d ios

  • For Web:

    flutter run -d chrome

Building

  • Android APK:

    flutter build apk

  • iOS:

    flutter build ios

  • Web:

    flutter build web

Development

Code Style

  • Follow Flutter's official style guide
  • Use dart format for code formatting
  • Maintain clean, readable code with meaningful comments

Contributing

Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.

Documentation

Detailed documentation can be found in the docs directory:

Security

For security concerns, please refer to our Security Policy.

License

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

Support

For support, please open an issue on GitHub or contact the maintainers listed in MAINTAINERS.md.