Skip to content

Commit

Permalink
more readme stuff
Browse files Browse the repository at this point in the history
  • Loading branch information
aniamisiorek committed Jan 11, 2024
1 parent 547dc57 commit 2a2cc91
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Fullstack application for the Algo project

## Quick Start

> TBD
```git clone [email protected]:GenerateNU/Algo.git```

## Set Up Your Development Environment
First, understand the tech stack:
Expand All @@ -23,17 +23,21 @@ The installation process can vary, so follow the instructions for each item belo

If everything was successful, you can now compile and run the project!

## Extra Dependencies

### Extra Dependencies
- go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
- go install github.com/cosmtrek/air@latest

## Tools
### Tools
We will be using some tools to make development a bit easier.

- [Swagger](https://github.com/swaggo/swag) - Will allow us to visualize the API and query requests from the database.
- [Makefile](https://opensource.com/article/18/8/what-how-makefile) - Will allow us to easily run scripts by consolidating them into Makefile commands. Make sure to read up about each command and ask questions. You should know what you are running!

### Third party integrations
For this project, we will be using some third-party APIs.

- [Morgan Stanley E-Trade](https://apisb.etrade.com/docs/api/authorization/request_token.html) - Our users will be able to log into their account using SSO. This is where we will pull portfolio data and make trade orders if requested. For testing purposes, we _highly_ recommend opening an E-Trade account. However, we understand money and financial information is highly sensitive, so if you do not feel comfortable opening an account, please let us know.

## Running the project

### Docker
Expand All @@ -44,8 +48,6 @@ You should be able to run `docker` in your terminal if this was successful.
2. Install [Docker Desktop](https://www.docker.com/products/docker-desktop/)
3. Run `docker-compose up` from the root directory, this will spin up a postgres image.

## Third party integrations
For this project, we will be using some third-party APIs.

- [Morgan Stanley E-Trade](https://apisb.etrade.com/docs/api/authorization/request_token.html) - Our users will be able to log into their account using SSO. This is where we will pull portfolio data and make trade orders if requested. For testing purposes, we _highly_ recommend opening an E-Trade account. However, we understand money and financial information is highly sensitive, so if you do not feel comfortable opening an account, please let us know.
### Backend
1. From root directory, run `make backend-run`

0 comments on commit 2a2cc91

Please sign in to comment.