BMaps

Overview

A single platform for events across campus. BMaps helps raise awareness of events by aggregating event information from various sources of advertising.

Built With

• Python 3.7 (base image python:3.7-alpine3.8)
• Postgres/Amazon RDS for PostgreSQL
• Flask
• Scikit-Learn
• Angular 7
• Mapbox
• NGINX
• Yarn
• AWS EC2/ELB/ECR

Setting Up the Environment

• Download Docker
  • Should come with Docker-Compose
  • Follow respective directions to install for Mac/Windows
• Clone the frontend, backend, and main BMaps repositories
  • Install as git submodules
    • git clone --recurse-submodules https://github.com/ucladevx/BMaps
    • Follow relevant instructions per repo
• Install AWS CLI (only for PM/TL)
  • Configure CLI with aws configure
  • Requires AWS secret info
  • Get aws-eb.pem permission file
  • NOTE: Computer local time must be accurate lol @Hakan
• Get the .env file which contains sensitive information from a dev and add it to BMaps-Backend/src/bmaps/utils/

How to Run Locally

• Run production build of stack

  • Uses production build of Angular Frontend and Flask Backend

  $ make run

• Stop the stack with Ctrl+C or make command

  $ make stop

• Kill any running containers if make stop fails

  $ make kill

How to Deploy on AWS

• Build and push frontend and backend images to AWS ECR

  $ make push

  • Can specifically push and tag the frontend or backend as well

    $ make push-be
    $ make push-fe

• Deploy to the production AWS EC2 instance

  • Files in deployment/ folder should be kept up to date with files in EC2 instance

  $ make ssh
  [ec2-user@... ~]$ make deploy

• Site should be live at www.bmaps.io

Dev Instance Deployment

• Can also build/push to a dev website for testing

  # Push backend and frontend
  $ make push-dev
  
  # Or can push backend/frontend separately
  $ make push-dev-be
  $ make push-dev-fe

• Deploy to the developmental AWS EC2 instance

  $ make ssh-dev
  [ec2-user@... ~]$ make deploy

The Team

• Hakan Alpay, PM/Frontend Dev/Backend Dev (Spring 2018 - Present)
• Ryan Holland, Tech Lead/Frontend Dev (Fall 2018 - Present)
• Linda Wu, Marketing (Winter 2019 - Present)
• Emily Wang, Designer (Fall 2019 - Present)
• Enika Biswas, Backend Dev (Spring 2019 - Present)
• Cindy Zhang, Backend Dev (Fall 2019 - Present)
• Radhika Ahuja, Frontend Dev (Spring 2019 - Present)
• Will Fehrnstrom, Frontend Dev (Spring 2019 - Present)
• Jack Zhang, Frontend Dev (Spring 2019 - Present)
• Amy Sywe, Frontend Dev (Fall 2019 - Present)
• Athya Uthayakumar, Frontend Dev (Fall 2019 - Present)
• Jay Park, Frontend Dev (Fall 2019 - Present)

Former Members

• Katrina Wijaya, Tech Lead/Backend Dev (Fall 2017 - Spring 2019)
• Doroty Sanussi, PM (Winter 2018 - Spring 2019)
• Tanzeela Khan, Frontend Dev (Fall 2017 - Spring 2018, Spring 2019)
• Jorge Fuentes, Backend Dev (Fall 2017 - Spring 2018, Spring 2019)
• Yinghao (Howard) Wang, Backend Dev (Fall 2018 - Spring 2019)
• Olivia Chen, Designer (Fall 2018 - Spring 2019)
• Lucy Liao, Designer (Fall 2017 - Spring 2018)
• Jason Xu, Backend Dev (Fall 2017 - Spring 2018)
• Sanketh Hegde, Frontend Dev (Winter 2018 - Winter 2019)
• Richard Sun, Frontend Dev (Spring 2018)
• Melissa Cox, Designer Intern (Spring 2018)
• Helen Lee, Frontend Dev (Fall 2017 - Winter 2018)
• Hannah Elarabawy, Frontend Dev (Fall 2017 - Winter 2018)
• Dharma Naidu, Backend Dev (Fall 2018)