Skip to content

Latest commit

 

History

History
118 lines (90 loc) · 4.68 KB

README.md

File metadata and controls

118 lines (90 loc) · 4.68 KB
Raw

Super Trader Flask

Super Trader is a Flask-based application designed for learning to trade stocks using live data. It allows users to view real-time & historic stock prices, make purchases, and track their favorite stocks & transaction history. Additionally, the admin panel provides features for managing user accounts, monitoring transactions, and more.

UML Diagram

Features

  • User Authentication: Users can register, login, and manage their accounts securely.
  • Stock Trading: Buy and sell stocks with real-time market data using websockets.
  • Portfolio Management: Track the stocks you own, view purchase history and analyze performance.
  • Favorite Stocks: Add and remove favorite stocks for quick access.
  • Admin Panel: Manage user accounts, view transaction history, and monitor system activity.

Installation

  1. Clone the repository:

    git clone https://github.com/AnkushSinghGandhi/super_trader_flask.git

  2. Navigate to the project directory:

    cd super_trader_flask

  3. Create a virtual environment (optional but recommended):

    python -m venv venv

  4. Activate the virtual environment:

    • On Windows: 
      venv\Scripts\activate
    • On macOS and Linux: 
      source venv/bin/activate

  5. Install the required dependencies:

    pip install -r requirements.txt

  6. Set up the database:

    • This project uses MongoDB as the database. Make sure you have MongoDB installed and running locally or update the database configuration in app/config.py.

  7. Start the Flask server:

    python app.py

  8. Access the application in your web browser at http://127.0.0.1:5000.

Usage

  • Register a new account or login with existing credentials.
  • Explore the stock market and add your favorite stocks to track.
  • Buy and sell stocks based on real-time market data.
  • Monitor your portfolio performance and transaction history.
  • Admins can manage user accounts, view transaction logs, and perform system maintenance tasks.

Flutter App

Super Trader Flask works in conjunction with the Super Trader Flutter mobile app, which provides the user interface for trading stocks and managing portfolios. The Flutter app communicates with this backend server to fetch stock data, perform transactions, and manage user accounts.

Repository

The Flutter app repository can be found at: https://github.com/AnkushSinghGandhi/super_trader_flutter

Contributing

Contributions are welcome! If you find any bugs or have suggestions for new features, please open an issue or submit a pull request.

License

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

Acknowledgements

Support

For any questions or assistance, feel free to contact the project maintainer at ankushsinghgandhi@gmail.com.

Thank you for using Super Trader Flask! Happy trading!