Rantr

A place to Rant about anything under the sun without being able to delete or update the rant

Features

• User Authentication

  • Email verification system
  • Password reset functionality
  • Multi-factor authentication support
  • User profile management

• Rant System

  • Create and share rants
  • Immutable rants (no editing or deletion)
  • Image support for rants
  • View count tracking
  • Popularity scoring system

• Social Features

  • Follow/unfollow other users
  • Like/unlike rants
  • Comment on rants
  • Reply to comments
  • View lists of rant likes
  • User following/followers lists

• Notifications

  • Real-time notifications for:
    • Likes on your rants
    • Comments on your rants
    • Replies to your comments
    • New followers
  • Mark notifications as read
  • Notification center with all updates

• Search and Discovery

  • Search functionality
  • "For You" feed with rants from followed users
  • General feed with all rants

• Conversations

  • Private messaging system
  • Conversation list and management
  • Start new conversations with users

• Internationalization

  • Multi-language support
  • Currently supports English and Portuguese

Settings

Moved to settings.

Basic Commands

Setting Up Your Users

• To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

• To create a superuser account, use this command:

  $ python manage.py createsuperuser
  

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.

Type checks

Running type checks with mypy:

$ mypy rantr

Test coverage

To run the tests, check your test coverage, and generate an HTML coverage report:

$ coverage run -m pytest
$ coverage html
$ open htmlcov/index.html

Running tests with pytest

$ pytest

Live reloading and Sass CSS compilation

Moved to Live reloading and SASS compilation.

Sentry

Sentry is an error logging aggregator service. You can sign up for a free account at https://sentry.io/signup/?code=cookiecutter or download and host it yourself. The system is set up with reasonable defaults, including 404 logging and integration with the WSGI application.

You must set the DSN url in production.

Deployment

The following details how to deploy this application.

Heroku

See detailed cookiecutter-django Heroku documentation.

Docker

See detailed cookiecutter-django Docker documentation.