Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smirnovlad/socialnetwork
HuaoMao social network, developed with Django + React
https://github.com/smirnovlad/socialnetwork
chat ci-cd django django-channels django-chat-app django-rest-framework djoser docker messenger nginx react redux social-network
Last synced: 15 days ago
JSON representation
HuaoMao social network, developed with Django + React
- Host: GitHub
- URL: https://github.com/smirnovlad/socialnetwork
- Owner: smirnovlad
- Created: 2023-12-26T14:52:14.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-03-11T20:17:50.000Z (8 months ago)
- Last Synced: 2024-10-15T04:49:29.530Z (about 1 month ago)
- Topics: chat, ci-cd, django, django-channels, django-chat-app, django-rest-framework, djoser, docker, messenger, nginx, react, redux, social-network
- Language: JavaScript
- Homepage:
- Size: 45.6 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# HuaoMao
## Project idea
**HuaoMao** is a social network with the following implemented features:
- Site authorization
- Creation of a personal profile with the ability to edit it (photo, birthday, city of residence)
- Adding friends
- Synchronized message exchange
- Ability to leave feedback about the site
### Implementation details
- Web application design: [design in Figma](https://www.figma.com/file/hlFAIfFrGb8HHlGH0B2Uy7/HuaoMao?type=design&node-id=0-1&mode=design&t=LrnYanTZAVLeXxYG-0)
- The backend of the application is written in Django. Djoser is used for authentication, and Django Channels for WebSocket notification.
- Frontend is developed using React + Redux.
### Example
At the time of writing this README, the application is hosted on the server http://158.160.113.82/. The virtual machine (server) is rented on Yandex Cloud.
#### Regular user
#### Admin workflow
Unauthenticated users can view the following pages:
- http://158.160.113.82/login
- http://158.160.113.82/profile/
- http://158.160.113.82/users
- http://158.160.113.82/feedback
## CI/CD
Upon push and pull request to the main branch, a workflow is triggered. It includes testing the application and deploying it to the remote server in case of success. A separate volume is allocated for the database, ensuring that its state remains current (not reset) with each update.
## How to build
### Locally
First, update the constants in `backend/backend/settings.py` and `react-app/src/api/config.js`, corresponding to the host and ports.
1. Apply migrations to data models from the backend directory:
```
python3 manage.py migrate
```
2. Run the server from the backend directory:
```
python3 manage.py runserver
```
3. Start the Docker container for handling sockets with Redis channels:
```
docker run -p 6379:6379 -d redis:5
```
4. Run the React application from the react-app directory:
```
npm install
npm start
```
### Dockerization
#### Local
1. First, bring up the container. From the project's root folder (where `docker-compose.yml` is located), execute:
```
docker-compose up -d
```
To rebuild images, execute:
```
docker-compose up --build
```
2. If the command ends with an error like:
```
ERROR: for nginx Cannot start service nginx: Ports are not available: exposing port TCP 0.0.0.0:80 -> 0.0.0.0:0: listen tcp 0.0.0.0:80: bind: address already in use
```
Check which process is occupying port 80:
```
sudo lsof -i :80
```
Terminate that process using:
```
sudo kill -9
```
If the port is occupied by the Apache server, run:
```
/etc/init.d/apache2 stop
```
#### Remote
Assuming **158.160.113.82** is the IP of the server where we want to run our application.
1. Create a context for remote SSH:
```
docker context create remoteContext --docker host=ssh://[email protected]
```
2. Now, start the container with the remote context:
```
docker-compose --context remoteContext up -d
```
#### Extra
- To update, for example, the host of the context:
```
docker context update \
--docker "host=ssh://[email protected]" \
remoteContext
```
- To remove the context:
```
docker context rm remoteContext
```
- Command to stop all containers:
```
docker stop $(docker ps -a -q)
```
- Command to remove all images:
```
docker system prune -a --volumes
```
## TODO
1. Devise more comprehensive tests (requests to the remote server, authentication, etc.)
2. Transition to JWT tokens
3. Add cryptographic dependencies
4. Add SEO support
5. Message notification outside the chat