add readme #4
19
LICENSE
Normal file
19
LICENSE
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
Copyright (c) 2025 Tianyu Liu, Studio TJ
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||||
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
|
||||||
|
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
||||||
|
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
|
||||||
|
OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
28
README.md
Normal file
28
README.md
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
|
||||||
|
# Trading Journal (Work In Progress)
|
||||||
|
|
||||||
|
A simple trading journal application (work in progress).
|
||||||
|
|
||||||
|
This repository contains the backend of a trading journal designed to help you record and analyse trades. The system is specially designed to support journaling trades for the "wheel" options strategy, but it also supports other trade types such as long/short spot positions, forex, and more.
|
||||||
|
|
||||||
|
Important: the project is still under active development. There is a backend in this repo, but the frontend UI has not been implemented yet.
|
||||||
|
|
||||||
|
## Key features
|
||||||
|
|
||||||
|
- Journal trades with rich metadata (strategy, entry/exit, P/L, notes).
|
||||||
|
- Built-in support and data model conveniences for the Wheel strategy (puts/calls lifecycle tracking).
|
||||||
|
- Flexible support for other trade types: long/short spots, forex, futures, etc.
|
||||||
|
- Backend-first design with tests and migration helpers.
|
||||||
|
|
||||||
|
## Repository layout
|
||||||
|
|
||||||
|
- `backend/` — Python backend code (API, models, services, migrations, tests).
|
||||||
|
- `backend/trading_journal/` — core application modules: CRUD, models, DTOs, services, and security.
|
||||||
|
- `backend/tests/` — unit tests targeting the backend logic and DB layer.
|
||||||
|
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
See the `LICENSE` file in the project root for license details.
|
||||||
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user