Skip to content

Commit

Permalink
formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
r0fls committed Jul 21, 2024
1 parent 4019297 commit d29e49d
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,31 +9,32 @@ We welcome contributions to the SOAD project. Here are some ways you can help:

## How to Contribute
1. Setup a python virtual environment
```
```bash
python -m pyenv python3.12
```
2. Install the required packages:
```
```bash
pip install -r requirements.txt
```
3. Initialize the database with fake data:
```
```bash
python init_db.py
```
4. Start the frontend (React) server
NOTE: right now you will have to edit this line in `src/axiosInstance.js` file locally to point to `http://localhost:8000`:
https://github.com/r0fls/soad/blob/main/trading-dashboard/src/axiosInstance.js#L4

Then:
```
```bash
cd trading-dashboard
yarn start
```
5. Start the python API (in a second terminal window)
```
```bash
python main.py --mode api

```## Code of Conduct
```
## Code of Conduct

If you have any problems getting, feel free to create a Github issue.

Expand Down

0 comments on commit d29e49d

Please sign in to comment.