Algo
Fullstack application for the Algo project
<img src="https://github.com/GenerateNU/Algo/actions/workflows/CI.yml/badge.svg"
alt="Workflow Status" />
Quick Start
git clone git@github.com:GenerateNU/Algo.git
Set Up Your Development Environment
First, understand the tech stack:
Before compiling and running our application, we need to install several languages, package managers, and various tools.
The installation process can vary, so follow the instructions for each item below!
- Go - our primary backend language
- Afterwards, install all go dependencies using
make backend-dep.
- yarn - our package manager in the frontend
- Afterwards, install all yarn dependencies using
make frontend-dep.
- expo-go - Expo allows mobile
devices to scan a QR code and view the code running on a mobile device. For development, we will use expo-cli, but this will be installed by the yarn
make frontend-dep command
- ngrok - Allows us to easily connect
- We recommend making an ngrok account and creating a static domain. This will let you simplify the backend URL tremendously, as otherwise the ngrok link will be randomly generated each time you run it.
If everything was successful, you can now compile and run the project!
Extra Dependencies
Install these in the backend directory
- 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 - Will allow us to visualize the API and query requests from the database.
- 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!
If you wish to simulate the app on a phone on your computer, the following will work;
- Xcode - A simulator to view the code on an iphone from a laptop
- Android Studio - An emulator to view the code on an android device from a laptop
Third party integrations
For this project, we will be using some third-party APIs.
- Morgan Stanley E-Trade - 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
Before running the project, you must add a .env file at the root directory. To this file, add the variable EXPO_PUBLIC_API_DOMAIN={your ngrok static domain here}. This will allow us to expose the development environment to the Internet. AKA, it puts localhost on the web for a short period.
Docker
We will be containerizing our PostGreSQL database in Docker. Follow the steps below to add the DB to your local machine.
- Install Docker
You should be able to run
docker in your terminal if this was successful.
- Install Docker Desktop
- Run
make db-run from the root directory, this will spin up a postgres image.
Backend
- From root directory, run
make backend-run
- Once this has succesfuly spun up, run
make backend-ngrok. This is necessary for connecting to a the different emulators, or your own phone if you download Expo Go.
Frontend
- From the root diectory, as long as you've already run
make frontend-dep recently, run make frontend-run. This will start the expo app.
- Starting an expo app has choices; it comes prepackeged with a QR code, which you can scan to open the app in Expo Go
- If you want to run the app on your computer, you will need to make sure you spin up the relevant emulator. This is either an Android Studio emulator if you want to run on Android, or an XCode simulator if you want to run on iOS
- To run on android, press a. To run on iOS, press i