Skip to content

Latest commit

 

History

History
180 lines (134 loc) · 7.05 KB

README.md

File metadata and controls

180 lines (134 loc) · 7.05 KB

PE Track: Week 1 - TEAM PYTHONIC - Portfolio Site

Introduction

TEAM PYTHONIC is from Pod 22.SUM.21 of the Production Engineering Track at MLH Fellowship.

For week 1, we made a reusable, modular and interactive team portfolio with an enjoyable user interface and a variety of multimedia components. We explored new technologies in Web Development (Flask, Jinja, Google Maps API), learned GitHub best practices to collaborate as a team, and also learned to write more modular, scalable and well-documented code.

Badges

GitHub code size in bytes GitHub repo size GitHub

Description

This is a reusable portfolio template which can be easily adapted to any number of team members. It is also mobile-friendly, which is an important feature considering that 50%+ of traffic on the web comes from mobile devices.

Team Pythonic's portfolio website consists of two main components:

Landing page
  • Animated heading text to display team name
  • Medium subheading, animated text to display team info
  • Profile pictures of each member which leads to their respective profile pages
Profile page

Cards with relevant profile sections, including:

  • About me
  • Experience
  • Projects
  • Countries I've visited: Interactive Google Map with markers of locations each member has visited
  • Hobbies: Hover effect tooltip boxes which display more information
Additional features
  • Landing page with pop-up CSS animations when user hovers over main text
  • Fully responsive website that adjusts according to screen size and works on mobile screens
  • Animated menu bar for switching profiles

Visuals

Landing page

Landing Page

Landing page on mobile

Mobile View

Profile page on mobile

Profile Mobile View

Technologies used in the project

  • The Python microframework Flask
  • HTML/CSS and Bootstrap
  • Jinja for templating (injecting Python code into HTML)
  • JSON for storing our data
  • JavaScript for the menu dropdown and map creation
  • Google Maps API in JavaScript to mark locations visited in each profile page

File Structure

main
│   README.md                               # You're reading this now!
|   LICENSE.md                              # Details of this project's MIT license
│   .gitignore                              # Files to be ignored by git
|   .python-version                         # Python version used to build the project
|   example.env                             # An example of what your .env should look like
|   requirements.txt                        # Requirements for Python dependencies to install using pip
|   data.json                               # Database containing info to be loaded into the app
│
└───app
    │   __init__.py                         # The Python init file that runs upon executing "flask run"
    │
    └───static
    |   └───fonts
    |   |   |   flux-regular.otf            # The same font style used by Python (free to use)
    |   |
    |   └───img
    |   |   |   (all images for website)    # Various images used in the project
    |   |
    |   └───scripts
    |   |   |   index.js                    # Script containing animation triggers for the landing page
    |   |   |   maps.js                     # Script that loads the Google Maps API into the DOM
    |   |   |   profile.js                  # Script containing animation trigger for the hamburger menu
    |   |
    |   └───styles
    |   |   |   index.css                   # Styles and animations for the landing page
    |   |   |   maps.css                    # Styles for the Google Map on profile page
    |   |   |   profile.css                 # Styles for static components on profile page
    |
    └───templates
        |   index.html                      # Template for the landing page
        |   profile.html                    # Template for the profile page

Installation

Make sure you have python3 and pip installed

Create and activate virtual environment using virtualenv

$ python -m venv python3-virtualenv
$ source python3-virtualenv/bin/activate

Use the package manager pip to install all dependencies!

pip install -r requirements.txt

Usage

Create a .env file using the example.env template (make a copy of the file, then replace the values if required)

Note: Add your own Google Maps API key in the .env file in order to use the map functionality

Start flask development server

$ export FLASK_ENV=development
$ flask run

You should get a response like this in the terminal:

❯ flask run
 * Environment: development
 * Debug mode: on
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

You'll now be able to access the website at localhost:5000 or 127.0.0.1:5000 in the browser!

Note: For now, the portfolio site will only work on your local machine while you have it running inside of your terminal. We plan to host it in the cloud in the next few weeks!

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Tasks

Each of the following tasks have been completed.

Note: Our team has ensured that we created an issue for each task, we used a new branch for each issue and made corresponding pull requests.

GitHub Tasks

  • Create Issues for each task below
  • Work on each task in a new branch
  • Open a Pull Request when a task is finished to get feedback

Portfolio Tasks

  • Add a photo of yourself to the website
  • Add an "About youself" section to the website.
  • Add your previous work experiences
  • Add your hobbies (including images)
  • Add your current/previous education
  • Add a map of all the cool locations/countries you visited

Flask Tasks

  • Get your Flask app running locally on your machine using the instructions.
  • Add a template for adding multiple work experiences/education/hobbies using Jinja
  • Create a new page to display hobbies.
  • Add a menu bar that dynamically displays other pages in the app

Acknowledgements

Authors