Skip to content

Latest commit

 

History

History
83 lines (53 loc) · 2.48 KB

README.md

File metadata and controls

83 lines (53 loc) · 2.48 KB
Raw

Pod 3.3.1 – Team 2 Portfolio

tags: MLH Documentation Fellow

Table of Contents

[TOC]

About the project

Portfolio website is the first project we developed as a team for hackaton week at MLH Fellowship. We focused on deliver a simple and clean UX/UI that would look awesome but not take focus on what is important.

Some of the features:

  • Dynamic animated background effects
  • Template generation based on profile selected

Of course, this is just an initial project that you could modify according to your needs, So we will try to keep adding new features in the future. Also, you may suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this project.

Built With

We use Flask as the main framework combined with Bootsrap 5.

Getting Started

In order to set up your project locally, follow these steps.

Prerequisites

Make sure you have python3 and pip installed

  • python3
  • pip 
    curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py

Installation

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

Contributing

Contributions to the project are welcome, that is one of the amazing things we have at the open source community. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Project Link: https://github.com/MLH-Fellowship/3.3.1.2-flask-blog

Appendix and FAQ

:::info Find this document incomplete? Leave a comment! :::