Code Monkey home page Code Monkey logo

chirpy-django's Introduction

Chirpy-Django

Chirpy is a platform where users can post their thoughts and others can comment and have a discussion.

codecov

Prerequisites

You will need to have the following installed:
- Python 3.8+
- Docker
- Docker Compose

Instructions to run the app

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

Features & bonus work

  1. You can sign-up & log-in
  2. You can share your thoughts via a post
  3. You will see posts submitted by all users on your home feed
  4. You can open any post and leave a comment
  5. You will get a notification count in navigation bar if people leave a comment on your post.
  6. You can open the notifications page by clicking on notifications button on navigation bar.
  7. You can mark unread notifications as read on notifications page.

Others

  1. Dependencies are being managed using Poetry
  2. Tests are added for all modules and sub-modules
  3. Github Actions CI is running tests with 100% coverage.
  4. Code and imports are formatted using black & isort.
  5. A superuser is already created for you with the app (Use admin/admin as username/password)

chirpy-django's People

Contributors

mzulqarnain1 avatar

Watchers

 avatar

chirpy-django's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.