Tickr 🚀📈

Welcome to Tickr, a free application which allows users to simulate trading in the stock market without the risk of losing real money. Whether you're a beginner wanting to learn how the stock market works or an experienced trader looking to test new strategies, this platform provides an interactive and educational environment for everyone.

---

Technologies Used 🛠

---

Features

• Simulated Stock Market: Trade stocks and track their performance in real-time, just like in the actual market.
• Risk-Free Environment: No real money is involved—users can practice without any financial risk.
• User-Friendly Interface: Easy-to-use platform with a sleek and intuitive design to enhance the trading experience.
• Market Data: Get live market data and trends for real stocks.
• Portfolio Management: Monitor your portfolio, track gains and losses, and analyze performance.
• Leaderboard: Compete with others and see who is the best trader among the mock users.

---

Design In Progress

Currently, the UI is a WIP and is not published to main yet. Here is the current design prototype.

Getting Started

Follow these steps to get started with the Mock Trading Platform:

1. Clone the Repository

git clone https://github.com/mcrich921/tickr.git

2. Set up Virtual Environment 🧑‍💻

cd tickr
python3 -m venv env

Windows:

.\env\Scripts\activate

macOS/Linux

source env/bin/activate

3. Install Backend Dependencies 📦

pip install -r requirements.txt

4. Connect to PostgreSQL Database 🗄️

To connect your app to a PostgreSQL database, follow these steps:

Install PostgreSQL: If you don't already have PostgreSQL installed, follow the instructions on the PostgreSQL website.

Create a Database: Once installed, create a new database and user for the project by running the following commands:

psql -U postgres
CREATE DATABASE mock_trading;
CREATE USER your_username WITH PASSWORD 'your_password';
GRANT ALL PRIVILEGES ON DATABASE your_database_name TO your_user_name;
\q

Update Database Configuration:

Find database config file at tickr/backend/backend/settings.py

Update the PostgreSQL connection settings with your database credentials.

DATABASES = {
    'default' : {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': 'mock_trading',      
        'USER': 'your_username',          
        'PASSWORD': 'your_password',               
        'HOST': 'localhost',          
        'PORT': '5432',         # Default PostgreSQL port   
    }
}

If you are running into issues, check what port your PostgreSQL is running on by doing:

psql -U postgres
SHOW port;

And update the PORT accordingly.

Run Migrations from tickr/backend: This will update your database with the built Django database.

python manage.py migrate

4. Install Frontend Dependencies

cd frontend
npm install

5. Start the Application 🖥️

Once in Tickr folder, activate frontend

cd frontend
npm run dev

and then backend

cd ../backend
python3 manage.py runserver

---

NOTE: NO REAL MONEY IS INVOLVED FOR DEPOSIT OR WITHDRAWAL IN THIS APPLICATION. IT IS PURELY A SIMULATION BASED ON LIVE STOCK DATA.