Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yuriidorosh/chess-forum
a specialized forum where users can make posts, chatting in real-time, create discussions for other users to respond to, and manage their data in a personal profile.
https://github.com/yuriidorosh/chess-forum
django django-application django-channels django-chess django-forum django-project python python-web python-web-development python3
Last synced: 3 months ago
JSON representation
a specialized forum where users can make posts, chatting in real-time, create discussions for other users to respond to, and manage their data in a personal profile.
- Host: GitHub
- URL: https://github.com/yuriidorosh/chess-forum
- Owner: YuriiDorosh
- License: mit
- Created: 2023-09-19T15:14:43.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-09T19:55:35.000Z (11 months ago)
- Last Synced: 2024-10-15T00:11:27.480Z (4 months ago)
- Topics: django, django-application, django-channels, django-chess, django-forum, django-project, python, python-web, python-web-development, python3
- Language: Python
- Homepage:
- Size: 770 KB
- Stars: 9
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Table of Contents
## Features
- Main page with information of the most liked posts and open discussions.
- Chats section.
- Page with posts where user can sort posts by date added or most likes.
- Discussions where users can discus, and if author receives a reply, they can close the discussion.
- Profiles containing information about the user, including their bio, photo, Telegram ID, chess profile URL, information about whether the user is a subscriber, user's posts, and posts liked by the user and authors can edit their profile and posts.
## Technology Stack
# Getting Started
## Run docker compose.
### Prerequisites
* Docker **24.0.6**
1. Clone the repo.
```sh
$ git clone [email protected]:YuriiDorosh/chess-forum.git
```
2. Define environment variables
```sh
$ cd chess-forum
$ nano .env
```
```env
SECRET_KEY=my_django_key
POSTGRES_DB=my_database
POSTGRES_USER=my_database_user
POSTGRES_PASSWORD=my_database_password
```
3. Build and run docker compose by predefined `make` command.
```sh
$ make setup
```
> WARNING!
> If database connection fails, try again in a few seconds. It could be because postress server is not running yet.
## Run as python script.
### Prerequisites
* python **3.10**
* pip
### Installation
1. Clone the repo.
```sh
$ git clone [email protected]:YuriiDorosh/chess-forum.git
```
2. Activate virtual environment.
```sh
$ cd chess-forum
$ python3 -m venv venv
$ source venv/bin/activate
3. Install requirements.
```sh
(venv) $ pip install -r requirements.txt
```
4. Define environment variables
```sh
$ nano .env
```
```env
SECRET_KEY=my_django_key
POSTGRES_DB=my_database
POSTGRES_USER=my_database_user
POSTGRES_PASSWORD=my_database_password
```
## Explanations
1. Database Structure.
`User`
Inheritance of the model from AbstractUser.
Includes the following information about the user: first name, last name, username, user bio (optional field), user photo (optional field), telegram user id (optional field), link to chess profile (optional field), whether the user is a subscriber to the service (by default False), and the date when the user was registered.
`UserPost`
Model inheritance from BaseModel.
Includes the following information about the user post: user id, post title, game link(optional field), body of post, and the date when the post was added.
`Like`
Model inheritance from BaseModel.
Includes the following information: user id, post id, date added.
`UserPostImage`
Model inheritance from Model.
Includes the following information: post id, image
`Room`
Model inheritance from BaseModel.
Includes the following information about the room: name, slug, if the room is premium(by default False), and the date when the room was created.
`Message`
Model inheritance from BaseModel.
Includes the following information: room id, user id, content of the message, and date when user write the message.
`Discussion`
Model inheritance from BaseModel.
Includes the following information about the discussion: title of the discussion, text, author(user) id, image(optional field), closed(by default False), and the date when discussion was created.
`Reply`
Model inheritance from BaseModel.
Includes the following information about the reply: discussion id, text, author id, image(optional field), and the date when reply was writing.
`ReplyLike`
Model inheritance from BaseModel.
Includes the following information about: reply id, user id, date added.
## License
This project is licensed under the MIT License. You can find the license details in the [LICENSE](LICENSE) file. Feel free to use, modify, and distribute the code as per the terms of the MIT License.
## Contacts
Yurii Dorosh
[](https://t.me/s11nd8r)
[](mailto:[email protected])
