Warbler

A server-side social media app where users can view messages, post messages, and like one another's posts. Users can follow one another, and view messages from users that they follow.

Explore the docs »
View Demo Site · Report Bug · Request Feature

Table of Contents

1. Built With
2. Getting Started
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

Built With

• 

(back to top)

Getting Started

1. Clone the repo

   git clone https://github.com/ari-denary/warbler.git

2. cd into project folder in terminal window

3. Create a virtual environment

python3 -m venv venv

4. Activate venv

source venv/bin/activate

5. Install in venv all items from requirements.txt

pip3 install -r requirements.txt

8. Run Flask

flask run

(back to top)

Tests

To run tests:

FLASK_DEBUG=False python -m unittest test_filename.py

Roadmap

• Add nav link to see messages from all users
• Refactor to use AJAX requests and reduce number of page reloads

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

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

(back to top)

Contact

Ari Denary - adenary.dev@gmail.com - LinkedIn

Project Link: https://github.com/ari-denary/warbler

(back to top)

Acknowledgments

• Co-creator: Terry Li

(back to top)