🍿 Repofolio

Repofolio makes building your portfolio a breeze. Use the repofolio library to auto-generate a dynamic portfolio from your Github. Then, sit back and relax 🏖️ as your repofolio ✨ magically ✨ updates itself whenever you update Github. Plus, viewers of your portfolio will be able to filter your repos by topic to easily find what they're looking for.

🎬 Watch the demo video at frankie.engineer/more

Features

• 🪄 Automatic updates when you add a new public repo
• ✨ Automatic updates when you change a repo's name, description, or homepage
• 🔎 Viewers of your repofolio can easily filter your repos by topic
• ⭐️ Draw attention to your favorite repos with highlights
• 🏆 Set the priority of repos so your favorites show up first
• 🎥 Link a video & thumbnail with each repo
• 🔧 Add projects without repos (e.g. non-disclosable code or non-software projects)
  
  

Setup

1. Install PostgreSQL
2. Install Python
3. Install Pipenv pip install pipenv
4. Create a Virtual Environment pipenv install --python "$PYENV_ROOT/versions/<<version_of_python_you_installed>>/bin/python"
5. Install all the dependencies npm install
6. Create .env file following the format of the .env.example file
7. Create .flaskenv file that contains the following: FLASK_APP=repofolio.py
8. Create the PostgreSQL database:

cd repofolio
psql    
DROP DATABASE repofolio; 
DROP USER repofolio;  
CREATE USER repofolio WITH PASSWORD '<insert-password-here>';   
CREATE DATABASE repofolio WITH OWNER repofolio;

9. Seed the database python database.py (Note: also run this command if you make any changes to the database structure i.e. you modify the models.py file)
10. Confirm data was seeded correctly SELECT * FROM repos;
11. Exit out of psql \q
12. Start the server: pipenv run flask run
13. If prompted to login to Github or create a Personal Access Token follow the prompts
    
    

Customize your Repofolio

1. ✅ Go to the /customizations directory and follow all of the instructions everywhere it says TODO
2. 🌍 Deploy your repofolio & push the data from your local database to your remote database
3. 🪄 Sit back and relax as your repofolio automatically updates itself whenever you make updates in Github.
   
   

Contact

💭 Have questions or feedback? I'd love to hear them! Send me (Frankie, she/her) a message at fwesparza@gmail.com