team-gen

TeamGen

TeamGen is a full-stack web application for finding the perfect team to be a part of. Intended for a class setting, the user is able to design a profile,choose exactly what they look for in teammates, and find or create their own team based off their given preferences.

Installation

# Clone the repo
git clone https://github.com/anthonydevelops/team-gen
cd /team-gen

# Create config/config.toml file with login credentials based off config/example_config.toml
touch config/config.toml

# Run Postgres, set environment if needed with -e (POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD)
# Also, create a local folder to have persistance of docker db image when developing
docker run -p 5433:5432 -e POSTGRES_PASSWORD=docker -e POSTGRES_DB=test --name pg --rm postgres

# Run server to test connection & begin development
go run main.go

Documentation

Detailed documentation can be found in the docs folder.

Architecture

TeamGen is built utilizing ReactJS as the component library for the front-end, Go for our backend server language to connect to PostgreSQL, and lastly Docker to build in a microservice-oriented way to improve many aspects of the application.

TODO Create architecture layout