feat: add updated README
This commit is contained in:
parent
e4781c0aa2
commit
d8b6f1117b
60
README.md
60
README.md
@ -1,2 +1,58 @@
|
||||
# Wesal
|
||||
A social app to connect with your colleagues within the Computer Operations Department (COD)
|
||||
# Wesal App
|
||||
|
||||
A social networking mobile application designed for connecting workplace colleagues. Wesal (Arabic for "connection") enhances communication and collaboration among division members.
|
||||
|
||||
## Features
|
||||
|
||||
- **Social Feed**: Create, view, like, and comment on posts
|
||||
- **Invitations**: Create and manage event invitations with RSVP functionality
|
||||
- **Daily Puzzles**: Timed daily challenges with leaderboards (9AM-11AM)
|
||||
- **Push Notifications**: Stay engaged with real-time updates
|
||||
|
||||
## Quick Start with Docker
|
||||
|
||||
1. **Clone and setup**:
|
||||
```bash
|
||||
git clone https://git.bubshait.me/sBubshait/wesal.git
|
||||
cd wesal
|
||||
chmod +x install.py
|
||||
sudo ./install.py
|
||||
```
|
||||
|
||||
2. **Run the application**:
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
3. **Access the services**:
|
||||
- Frontend: http://localhost:6060
|
||||
- Backend API: http://localhost:4044
|
||||
- API Docs: http://localhost:4044/docs
|
||||
- Database Admin: http://localhost:8100
|
||||
|
||||
## Technology Stack
|
||||
|
||||
- **Frontend**: Flutter 3.8.1+
|
||||
- **Backend**: Spring Boot 3.5.3 (Java 21)
|
||||
- **Database**: PostgreSQL
|
||||
- **Authentication**: JWT tokens
|
||||
- **Notifications**: Firebase Cloud Messaging
|
||||
- **Deployment**: Docker containerization
|
||||
|
||||
## Documentation
|
||||
|
||||
For detailed technical documentation, installation guides, development setup, and troubleshooting, see:
|
||||
📖 **[Complete Documentation](docs/docs.pdf)**
|
||||
|
||||
## Development
|
||||
|
||||
See the [full documentation](docs/docs.tex) for:
|
||||
- Manual setup instructions
|
||||
- Development commands
|
||||
- Testing procedures
|
||||
- API documentation
|
||||
- Troubleshooting guide
|
||||
|
||||
## Support
|
||||
|
||||
Contact COD/DPSD for application support and maintenance information.
|
||||
Loading…
Reference in New Issue
Block a user