StockODiary

Stockodiary is a platform where traders related to financial markets create, plan, organize and analyze their trades.

About
Features
Installation
Usage
Contributing
License
Acknowledgements

About

Stockodiary is a platform where traders related to financial markets create, plan, organize and analyze their trades.

Features

Installation

### Ubuntu

Install required packages

sudo apt-get update
sudo apt-get install python3-pip python3-dev libpq-dev postgresql postgresql-contrib

Create a Database

sudo -u postgres psql
CREATE DATABASE sod;
\q

Create a .env file in the root directory of the project and add the following environment variables:
```
SOD_ENV="dev"
DB_USER="<YOUR_DB_USER>"
DB_PASSWORD="<YOUR_DB_PASSWORD>"
```

Usage

Note: For window users, replace python3 with python.

Navigate to repo
```
cd SOD/
```
Create a Python environment
```
python3 -m venv .venv --prompt "SOD"
```

Activate the environment

Windows

.venv\Scripts\activate

Linux/Mac

source .venv/bin/activate

Install the required packages

python3 -m pip install -r requirements.txt

Make db migrations
```
python3 manage.py migrate
```
Run the server
```
python3 manage.py runserver
```

Project will be running at localhost:8000

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow these guidelines:

Fork the repository

Clone it to your local machine.

git clone https://github.com/sameershaik-coder/SOD.git

Create a new branch for your feature or bug fix:
```
git checkout -b feature-name
```

Make your changes and commit them:

git add .
git commit -m '<Description of your changes>'

Push your changes to your fork:
```
git push origin feature-name
```
Submit a pull request to the main repository's main branch.

If you find any bugs or have suggestions for improvements, please open an issue on the GitHub repository.

License

This project is licensed under the Apache 2.0 - see the LICENSE file for details.

However the code used for UI is not open source and must be purchased from the below url:

All rights related UI templates kit and source code related to templates kit belongs with owner listed in above urls.

Please contact and purchases licenses as applicable before you use the application in the production.

Param302/SOD