Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add "README.md" file in repository #17

Merged
merged 1 commit into from
Jan 2, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Lablup Internship Onboarding Assignment - Web Chat
This assignment involves implementing a web-based chat application using asyncio, aiohttp, and redis.
## Contents in This Repository
This repository includes both the chat server and the chat web application
* `chat-server`: Chat server
* `chat-web`: Chat web application
* `backend.Dockerfile`: Dockerfile for the chat server
* `frontend.Dockerfile`: Dockerfile for the chat web application
* `docker-compose.yml`: Docker Compose configuration file
* `build.sh`: Script to run Docker Compose automatically
* `README.md`: This file
## Run Automatically
Since Docker Compose is used for automatic execution, Docker installation is required.
### 권한 부여
```bash
chmod +x ./build.sh
```
### Run build.sh
```bash
./build.sh
```
If executed successfully, you can access the chat web application at localhost:3001.
## Run Manually
For manual execution instructions, please refer to the README.md file in each project directory.
Loading