jmonteza / project-bored-apes

project-bored-apes created by GitHub Classroom

Bored Apes Portfolio - MLH Fellowship Orientation Hackathon

Portfolio inspired by Bored Apes, unique digital collectibles living on the Ethereum blockchain

Screenshot

Tasks

Once you've got your portfolio downloaded and running using the instructions below, you should attempt to complete the following tasks.

For each of these tasks, you should create an Issue and work on them in a new branch. When the task has been completed, you should open a Pull Request and get another fellow in your pod to give you feedback before merging it in.

Note: Make sure to include a link to the Issue you're working on inside of your Pull Request so your reviewer knows what you're working on!

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 below.
• 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

Getting Started

You don't need to submit any pull requests to this repository. You need to do all your work here.

Prerequisites

• Flask
• Google Maps API
• Gmail API

Installation

Make sure you have python3 and pip installed

Create and activate virtual environment using venv

Bash

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

CMD

> python -m venv python3-virtualenv
> python3-virtualenv/bin/activate

Use the package manager pip to install all dependencies!

pip install -r requirements.txt

Tech Stack

Python, HTML, CSS, JavaScript, JSON, Gmail API, Google Maps API, jQuery, Flask, Bulma

Usage

Create a .env file using the example.env template (make a copy using the variables inside of the template)

Start flask development server

Bash

$ export FLASK_ENV=development
$ export FLASK_DEBUG=1
$ flask run

CMD

> set FLASK_ENV=development
> set FLASK_DEBUG=1
> 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: The portfolio site will only work on your local machine while you have it running inside of your terminal. We'll go through how 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.

Please see CONTRIBUTING.md.

Roadmap

• Integrate database
• Add a blogging feature
• Host it on the cloud
• Add automated tests

License

Bored Apes Portfolio is MIT licensed.

Authors

Justin Monteza @jmonteza

Logan Hoogendijk @LoganHoogendijk

Hadi Chaaban @HadiCya