https://github.com/monosans/socnet
Social network built with Django Framework.
https://github.com/monosans/socnet
Last synced: over 1 year ago
JSON representation
Social network built with Django Framework.
- Host: GitHub
- URL: https://github.com/monosans/socnet
- Owner: monosans
- License: mit
- Created: 2022-06-10T16:42:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:36:41.000Z (over 1 year ago)
- Last Synced: 2024-10-29T13:25:52.769Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 6.35 MB
- Stars: 10
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SocNet
[](https://github.com/monosans/socnet/actions/workflows/ci.yml)
Social network built with Django Framework.
## Features
- Multi-language (currently English and Russian). Selected based on browser settings.
- Light and dark theme support with a switch. The browser theme is selected by default.
- Infinite scrolling.
- Progressive Web App (PWA) support.
### Regular users
- Register and confirm their account by email
- Sign in
- Add backup email addresses in case they lose access to the primary address
- Reset and change their password
- Use two-factor authentication with time-based one-time passwords (TOTP)
- Provide information about themselves in their profile
- Write real-time messages with Markdown and HTML support to other users using WebSockets
- Create, edit, like and delete posts and comments with Markdown and HTML support
- View images in posts, comments and messages as a gallery using [viewerjs](https://fengyuanchen.github.io/viewerjs/)
- Subscribe to other users to see their posts in their news feed
- Inexact search for posts by text
- Inexact search for messages by text
- Inexact search for users by selectable fields
- Delete their account
- And a lot of other little things
### Administrators
- All of the above
- Use Django admin panel
- Receive error notifications in [Sentry](https://sentry.io/) or by email
## Installation
[Install `Docker Compose`](https://docs.docker.com/compose/install/).
### Configuration
Copy the `.env.example` file to `.env`. Set the settings you need in the `.env` file.
### Development
```bash
# Pull service images
docker compose pull --ignore-buildable
# Build services
docker compose build --pull
# Run DB migrations
docker compose run --rm django python3 manage.py migrate
# Create a superuser if you want
docker compose run --rm django python3 manage.py createsuperuser
# Compile translations
docker compose run --rm django python3 manage.py compilemessages --locale en --locale ru
# Run without debugpy
docker compose up --remove-orphans
# Or run with debugpy
docker compose -f compose.yaml -f compose.override.yaml -f compose.debug.yaml up --remove-orphans
```
### Production
To run this in production, you need to specify the production settings in `.env`.
```bash
# Pull service images
docker compose -f compose.yaml -f compose.prod.yaml pull --ignore-buildable
# Build services
docker compose -f compose.yaml -f compose.prod.yaml build --pull
# Run DB migrations
docker compose -f compose.yaml -f compose.prod.yaml run --rm django python3 manage.py migrate
# Create a superuser if you want
docker compose -f compose.yaml -f compose.prod.yaml run --rm django python3 manage.py createsuperuser
# Run
docker compose -f compose.yaml -f compose.prod.yaml up -d --remove-orphans
```
## Tech Stack
### Containerization
- Docker
- Docker Compose
### Backend
- Python 3.13
- Django 5.1
- django-allauth
- django-bootstrap5
- django-cleanup
- django-environ
- django-filter
- django-logentry-admin
- django-ninja
- channels
- channels-redis
- sentry-sdk
- websockets
Markdown parsing, HTML minification and sanitization, and a few other things are implemented in Rust in the `socnet_rs` package using the following libraries:
- ammonia
- minify-html
- pulldown-cmark
- pyo3
### Databases
- PostgreSQL 17 for persistent data
- Valkey 8 (FOSS Redis fork) for cache and as a layer for Channels
### Frontend
- HTML with Django Template language
- HTMX 2
- Bootstrap CSS 5.x
- Font Awesome 6
- TypeScript (compiled and minified with esbuild)
- viewerjs
- luxon
### Web servers
- Caddy
- gunicorn
- uvicorn
### Testing
- pytest
- factory-boy
### Linting
- mypy
- ruff
- eslint
- stylelint
## DB schema
## License
[MIT](LICENSE)