Update README.md with updated information

This commit is contained in:
Xevion
2022-04-04 22:18:35 -05:00
parent 285e05c3d1
commit 62acccb6b8

View File

@@ -1,13 +1,16 @@
# runnerspace # 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 ## 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 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 ## 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 - Online and Offline account flags
- Posts - Posts
- Post Creation - Post Creation
- Comment posting
- Post Feed + Comment Stats - Post Feed + Comment Stats
- AJAX Post Liking System
- Appearance - Appearance
- Customized to look like MySpace; UTSA themed - Customized to look like MySpace; UTSA themed
- CSS written to be usable on most laptops/desktops - CSS written to be usable on most laptops/desktops
- MySpace-like Theme - MySpace-like Theme
- Image used, although text-based logo fallback available - Image used, although text-based logo fallback available
- Misc - Misc
- Easy install & setup with `pipenv`
- Hosted on [Heroku][heroku-url]!
- Profanity filtering
- Human + Computer Readable Timestamps - Human + Computer Readable Timestamps
- "3 minutes ago" and such... - "3 minutes ago" and such...
- Global Header & Footer - Global Header & Footer
@@ -41,9 +49,11 @@ We made this app starting almost 5 hours after this 24-hour Hackathon started an
- SQLAlchemy + SQLite - SQLAlchemy + SQLite
- Sass - Sass
- Font Awesome Icons - Font Awesome Icons
- Heroku
- Other - Other
- Humanize - Humanize
- Faker - Faker
- `better-profanity`
# Development Setup # Development Setup
@@ -55,4 +65,6 @@ pipenv install
flask run flask run
``` ```
Not production ready yet.
[banner-url]: ./static/runnerspace-banner-slim.png
[heroku-url]: https://runnerspace-utsa.herokuapp.com/