/news

WebApp to summrize local news sources in one place

Primary LanguageJupyter Notebook

License: MIT Python: 3.8

Trading Platform

GitHub license GitHub issues GitHub stars

A robust and efficient trading platform that allows users to buy and sell stocks in real-time.

Table of Contents

Features

  • Users can create an account, login and logout securely
  • Users can view their portfolio, including their current holdings and total value
  • Users can place market or limit orders to buy or sell stocks
  • Users can view their order history and pending orders
  • Admins can add new stocks to the platform
  • Charts are available to visualize stock prices over time
  • Flask endpoints have been thoroughly tested

Endpoints

  • GET /: displays the home page
  • GET /login: displays the login page
  • POST /login: logs in the user
  • GET /register: displays the registration page
  • POST /register: registers the user
  • GET /logout: logs out the user
  • GET /stocks: displays a list of all available stocks
  • GET /stocks/<stock_id>: displays detailed information about a specific stock
  • POST /buy: allows the user to buy a stock
  • POST /sell: allows the user to sell a stock
  • GET /orderbook: displays the order book
  • GET /chart/<stock_id>: displays a chart of the price history for a specific stock
  • GET /admin: displays the admin dashboard (requires admin login)
  • POST /admin/add_stock: adds a new stock to the platform (requires admin login)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/trading-platform.git
cd trading-platform

  2. Create and activate a virtual environment:

    python -m venv env
source env/bin/activate

  3. Install the required dependencies:

    pip install -r requirements.txt

  4. Create the database and tables:

    python db.py

  5. Start the Flask app:

    export FLASK_APP=run.py
export FLASK_ENV=development
flask run

  6. Visit http://localhost:5000 in your web browser to access the app.

Usage

  1. Create a user account by clicking on the "Register" link in the top right corner of the app. You will be redirected to the registration page where you can create a new account by providing a username, email and password.

  2. Log in to the app using the username and password you just created. You will be redirected to the dashboard where you can view your portfolio, place orders and view your order history.

  3. To place an order, click on the "Place Order" button on the dashboard. You can then select a stock to trade, the type of order (market or limit) and the quantity you wish to trade.

  4. To view your order history, click on the "Order History" link in the top right corner of the app. You can view your completed orders as well as any pending orders.

  5. To view charts of the stock prices over time, click on the "Charts" link in the navigation bar. You can then select a stock to view the chart for.

  6. If you are an admin user, you can add new stocks to the platform by clicking on the "Admin" link in the navigation bar and then clicking on the "Add Stock" button.

Contributing

  1. Fork the repository.

  2. Create a new branch:

    git checkout -b my-feature-branch

  3. Make changes and commit them:

    git add .
git commit -m "Add new feature"

  4. Push your changes to your fork:

    git push origin my-feature-branch

  5. Create a pull request.

License

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