Skip to content

Latest commit

 

History

History
96 lines (66 loc) · 3.21 KB

README.md

File metadata and controls

96 lines (66 loc) · 3.21 KB

Freemarket Stock App

Welcome friends! This is the codebase for the Freemarket Stock App.

Home Screen Chart Screen Alert Screen

Features

  • Track real-time cryptocurrency prices.
  • Receive personalized price alerts.
  • Analyze trends with interactive charts.

User Installation

Get the app itself:

Built with

  • Flutter : For building cross-platform apps with a single codebase
  • CoinGecko API : For fetching real-time cryptocurrency data.

Getting started with development

Follow these steps to set up and run the Freemarket project on your local machine for development.

Prerequisites

Ensure you have the following installed:

Firebase Setup

To configure Firebase for the project, follow these steps:

  1. Create a Firebase Project
    Go to the Firebase Console, create a new project, and follow the setup instructions.

  2. Add Firebase to your Flutter app

    • For iOS, you need to download the GoogleService-Info.plist file from Firebase and add it to your iOS project directory (in the ios/Runner folder).
    • For Android, download the google-services.json file from Firebase and place it in the android/app directory.
  3. Enable Firebase Services
    Depending on the services you're using in the app (e.g., Firebase Authentication, Firebase Firestore, Firebase Analytics), enable them in the Firebase console and follow any additional setup steps outlined in the Firebase documentation.

  4. Install Firebase Flutter Plugins
    In your pubspec.yaml, add the necessary Firebase dependencies. For example:

    dependencies:
      firebase_core: ^latest_version
      firebase_auth: ^latest_version
      cloud_firestore: ^latest_version
      # Add other Firebase services you plan to use
    

Setup Instructions

  1. Clone the Repository
    Clone the project to your local machine using Git:

    git clone https://github.com/vuzzer/freemarket.git
    cd freemarket
    
  2. Install Dependencies

     flutter pub get
  3. Run the Project

    Run the app on a connected device or emulator

       flutter run
  4. Troubleshooting

    If you encounter SDK-related errors, verify your Flutter installation by running :

      flutter doctor

License

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