diff --git a/README.md b/README.md index 0a1f679..e68a2db 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,16 @@ # runnerspace -A retro myspace clone for UTSA students. +[![Runnerspace Banner](banner-url)](heroku-url) + +Runnerspace is a retro, UTSA-themed MySpace clone made in less than 36 hours during RowdyHacks 2022. It was intended for the 'Retro' challenge +and has been further overhauled afterwards to become a portfolio project, hosted on Heroku. Check it out by clicking on the banner or [here][heroku-url]. ## About Made during Rowdy Hacks 2022, this myspace look-a-like was quickly made with intentions of serving the UTSA student community. We took heavy -inspiration from my-space and other social media services of it's era. +inspiration from my-space and other social media services of its era. -We made this app starting almost 5 hours after this 24-hour Hackathon started and in total I stayed up for around 36 hours straight to +We made this app starting almost 5 hours after this 24-hour Hackathon started and were able to successfully present a finished demo for judging at RowdyHacks 2022. ## Features @@ -20,13 +23,18 @@ We made this app starting almost 5 hours after this 24-hour Hackathon started an - Online and Offline account flags - Posts - Post Creation + - Comment posting - Post Feed + Comment Stats + - AJAX Post Liking System - Appearance - Customized to look like MySpace; UTSA themed - CSS written to be usable on most laptops/desktops - MySpace-like Theme - Image used, although text-based logo fallback available - Misc + - Easy install & setup with `pipenv` + - Hosted on [Heroku][heroku-url]! + - Profanity filtering - Human + Computer Readable Timestamps - "3 minutes ago" and such... - Global Header & Footer @@ -41,9 +49,11 @@ We made this app starting almost 5 hours after this 24-hour Hackathon started an - SQLAlchemy + SQLite - Sass - Font Awesome Icons +- Heroku - Other - Humanize - Faker + - `better-profanity` # Development Setup @@ -55,4 +65,6 @@ pipenv install flask run ``` -Not production ready yet. + +[banner-url]: ./static/runnerspace-banner-slim.png +[heroku-url]: https://runnerspace-utsa.herokuapp.com/