Silly Bird App

View documentation »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
3. License
4. Contact
5. Acknowledgments

About The Project

Silly Bird App is a social media platform not unlike another silly bird app you might be familiar with. Users can create accounts, follow other users, make posts, like posts as well as edit their profile and posts. I launched this project in spring 2023 as part of Rithm School's curriculum, and despite some light refactoring since then I've mostly transitioned to creating other projects.

Silly Bird is a Flask app that uses Postgresql for its database with SQLAlchemy as an ORM. User data is securely handled via the bcrypt library, which salts and hashes passwords through one-way encryption. Pages are rendered from html templates designed with Jinja and JQuery styled in Bootstrap.

(back to top)

Built With

(back to top)

Getting Started

To see the project in action, visit the demo.

Otherwise, to build Silly Bird App from source:

1. Clone the repo:

git clone https://github.com/jclark1913/warbler

2. Create and seed the database

createdb warbler
cd warbler
python3 seed.py

3. Create a virtual environment (venv) inside the root directory (optional but recommended)

cd warbler
python3 -m venv venv
source venv/bin/activate

4. Install dependencies and run the backend server (defaults to port 5000)

cd warbler
pip3 install -r requirements.txt
flask run

4. Visit localhost:5000

(back to top)

License

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

(back to top)

Contact

Justin Clark - @JustinClarkJO - jclarksummit AT gmail DOT com

Project Link: https://github.com/jclark1913/warbler

(back to top)

Acknowledgments

I completed this project during my time at Rithm School. A big thanks to all the instructors and classmates who encouraged and supported me during that time.

• Rithm School
• Best-README-Template

(back to top)