Chirpy is a platform where users can post their thoughts and others can comment and have a discussion.
You will need to have the following installed:
- Python 3.8+
- Docker
- Docker Compose
To get started using this app right away:
cd
into project root directory- Build the docker images using
docker-compose build
- Run the docker app using
docker-compose up
- Visit http://0.0.0.0:8000/ in your browser
- You can sign-up & log-in
- You can share your thoughts via a post
- You will see posts submitted by all users on your home feed
- You can open any post and leave a comment
- You will get a notification count in navigation bar if people leave a comment on your post.
- You can open the notifications page by clicking on notifications button on navigation bar.
- You can mark unread notifications as read on notifications page.
- Dependencies are being managed using Poetry
- Tests are added for all modules and sub-modules
- Github Actions CI is running tests with 100% coverage.
- Code and imports are formatted using
black
&isort
. - A superuser is already created for you with the app (Use admin/admin as username/password)