Skip to content

Commit ebd3ca2

Browse files
authored
Update README.md
1 parent a4cebff commit ebd3ca2

1 file changed

Lines changed: 38 additions & 0 deletions

File tree

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Coding Black Females - My Trading Algorithm Application
2+
3+
### Overview
4+
This project is a Java- based trading algorithm designed to automate decision making in the financial markets. The algorithm does this by analysing the order and executing buy and sell actions based on market conditions. The project aims to simplify trading operations by automatically managing orders, this helps users to make timely trading decisions without manual intervention. The main problem it addresses is the need for efficient and rule-based order management in fast-moving markets. It reduces human error by automating repetitive tasks like matching buy and sell orders, creating new orders based on specific conditions, and cancelling orders that no longer meet the criteria. This type of automation is particularly valuable for traders who want to capitalise on market opportunities quickly while adhering to a pre-defined strategy.
5+
6+
This project is useful because it enhances trading efficiency by using predefined thresholds and actions to guide decision-making. The algorithm’s logging system also provides real-time insights into its operations, which helps in monitoring performance and refining trading strategies. My project offers an extendable framework starting point for developers and traders interested in creating or optimising algorithmic trading solutions.
7+
8+
### How to Get Started
9+
10+
#### Pre-requisites
11+
12+
1. The project requires Java version 17 or higher
13+
14+
##### Note
15+
This project is configured for Java 17. If you have a later version installed, it will compile and run successfully, but you may see warnings in the log like this, which you can safely ignore:
16+
17+
```sh
18+
[WARNING] system modules path not set in conjunction with -source 17
19+
```
20+
21+
#### Opening the project
22+
23+
1. Fork this repo in GitHub and clone it to your local machine
24+
2. Open the project as a Maven project in your IDE (normally by opening the top level pom.xml file)
25+
3. Click to expand the "getting-started" module
26+
27+
##### Note
28+
You will first need to run the Maven `install` task to make sure the binary encoders and decoders are installed and available for use. You can use the provided Maven wrapper or an installed instance of Maven, either in the command line or from the IDE integration.
29+
30+
To get started, run the following command from the project root: `./mvnw clean install`. Once you've done this, you can compile or test specific projects using the `--projects` flag, e.g.:
31+
32+
- Clean all projects: `./mvnw clean`
33+
- Test all `algo-exercise` projects: `./mvnw test --projects algo-exercise`
34+
- Compile the `getting-started` project only: `./mvnw compile --projects algo-exercise/getting-started`
35+
- Then run the Algotest/ AlgoBacktest to see the output of my code
36+
37+
☺️ 💻
38+

0 commit comments

Comments
 (0)