-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from GenerateNU/docker-setup
Fullstack setup
- Loading branch information
Showing
16 changed files
with
572 additions
and
43 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
|
|
@@ -17,16 +17,37 @@ Before compiling and running our application, we need to install several languag | |
| The installation process can vary, so follow the instructions for each item below! | ||
|
|
||
| - [Go](https://go.dev/doc/install) - our primary backend language | ||
| - Afterwards, install all go dependencies with the command `go get .` in the root directory. This needs to be re-run if dependencies change. | ||
| - Afterwards, install all go dependencies using `make backend-dep`. | ||
| - [yarn](https://classic.yarnpkg.com/en/docs/install#mac-stable) - our package manager in the frontend | ||
| - Afterwards, install all yarn dependencies with the command `yarn --dir frontend install` in the root directory. | ||
| - Afterwards, install all yarn dependencies using `make frontend-dep`. | ||
|
|
||
| If everything was successful, you can now compile and run the project! | ||
|
|
||
| ### Extra Dependencies | ||
| - go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest | ||
| - go install github.com/cosmtrek/air@latest | ||
|
|
||
| ### 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 | ||
| We will be containerizing our PostGreSQL database in Docker. Follow the steps below to add the DB to your local machine. | ||
|
|
||
| 1. Install [Docker](https://docs.docker.com/get-docker/) | ||
| 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. | ||
|
|
||
| ### Backend | ||
| 1. From root directory, run `make backend-run` | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package configuration | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
| "runtime" | ||
|
|
||
| "github.com/spf13/viper" | ||
| ) | ||
|
|
||
| type Settings struct { | ||
| Database DatabaseSettings `yaml:"database"` | ||
| } | ||
|
|
||
| type DatabaseSettings struct { | ||
| Username string `yaml:"username"` | ||
| Password string `yaml:"password"` | ||
| Port uint16 `yaml:"port"` | ||
| Host string `yaml:"host"` | ||
| DatabaseName string `yaml:"databasename"` | ||
| RequireSSL bool `yaml:"requiressl"` | ||
| } | ||
|
|
||
| type Environment string | ||
|
|
||
| const ( | ||
| EnvironmentLocal Environment = "local" | ||
| EnvironmentProduction Environment = "production" | ||
| ) | ||
|
|
||
| var ( | ||
| _, b, _, _ = runtime.Caller(0) | ||
| basepath = filepath.Dir(b) | ||
| ) | ||
|
|
||
| func GetConfiguration() (Settings, error) { | ||
| v := viper.New() | ||
| v.SetConfigType("yaml") | ||
| v.AddConfigPath(basepath) | ||
|
|
||
| var settings Settings | ||
|
|
||
| var environment Environment | ||
| if env := os.Getenv("GITHUB_ACTIONS"); env != "" { | ||
| environment = Environment("github") | ||
| } else { | ||
| environment = "local" | ||
| } | ||
|
|
||
| v.SetConfigName(string(environment)) | ||
|
|
||
| if err := v.ReadInConfig(); err != nil { | ||
| return settings, fmt.Errorf("failed to read %s configuration: %w", "local", err) | ||
| } | ||
|
|
||
| if err := v.Unmarshal(&settings); err != nil { | ||
| return settings, fmt.Errorf("failed to unmarshal configuration: %w", err) | ||
| } | ||
|
|
||
| return settings, nil | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| database: | ||
| host: '172.17.0.1' | ||
| port: 5432 | ||
| username: 'user' | ||
| password: 'pwd' | ||
| databasename: 'carewallet' | ||
| requiressl: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| database: | ||
| host: 'localhost' | ||
| port: 5434 | ||
| username: 'user' | ||
| password: 'pwd' | ||
| databasename: 'carewallet' | ||
| requiressl: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.