Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mlh-fellowship/project-vitrina
project-vitrina created by GitHub Classroom
https://github.com/mlh-fellowship/project-vitrina
flask jinja2-templates leaflet-map leafletjs mlh-fellowship
Last synced: 16 days ago
JSON representation
project-vitrina created by GitHub Classroom
- Host: GitHub
- URL: https://github.com/mlh-fellowship/project-vitrina
- Owner: MLH-Fellowship
- Created: 2023-01-31T22:23:30.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-23T21:34:47.000Z (almost 2 years ago)
- Last Synced: 2024-12-16T19:13:31.603Z (17 days ago)
- Topics: flask, jinja2-templates, leaflet-map, leafletjs, mlh-fellowship
- Language: Python
- Homepage:
- Size: 5.78 MB
- Stars: 1
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Site Reliability Engineering - Week 1 - Portfolio Site
Welcome to the MLH Fellowship! During Week 1, you'll be using Flask to build a portfolio site. This site will be the foundation for activities we do in future weeks so spend time this week making it your own and reflect your personality!
## 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](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and work on them in a new [branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches). When the task has been completed, you should open a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) 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 progressing on inside of your Pull Request so your reviewer knows what you're progressing on!*
### GitHub Tasks
- [x] Create Issues for each task below
- [x] Progress on each task in a new branch
- [x] Open a Pull Request when a task is finished to get feedback
### Portfolio Tasks
- [x] Add a photo of yourself to the website
- [x] Add an "About youself" section to the website.
- [x] Add your previous work experiences
- [x] Add your hobbies (including images)
- [x] Add your current/previous education
- [x] Add a map of all the cool locations/countries you visited
### Flask Tasks
- [x] Get your Flask app running locally on your machine using the instructions below.
- [x] Add a template for adding multiple work experiences/education/hobbies using [Jinja](https://jinja.palletsprojects.com/en/3.0.x/api/#basics)
- [x] Create a new page to display hobbies.
- [x] Add a menu bar that dynamically displays other pages in the app
## Getting Started
You need to do all your progress here.
## Installation
Make sure you have python3 and pip installed
Create and activate virtual environment using virtualenv
```bash
$ python -m venv python3-virtualenv
$ source python3-virtualenv/bin/activate
```
Use the package manager [pip](https://pip.pypa.io/en/stable/) to install all dependencies!
```bash
pip install -r requirements.txt
```
## 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
$ 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.