Коммит 6c35bce8 создал по автору Radch-enko's avatar Radch-enko
Просмотр файлов

docs: update README with expanded details and tablet demo

- Added project goal and technical goal sections.
- Introduced features overview with a detailed feature table.
- Included a tablet demo GIF for better visualization.
- Updated project structure and contributing sections for clarity.
- Mentioned the upcoming TV application in the roadmap.
владелец 00b19b55
# Effective Office
## Overview
Effective Office is a comprehensive office management system designed to streamline workplace operations, resource management, and employee interactions. The project consists of a backend server and tablet clients that work together to create an efficient office environment.
## Features
- Resource booking and management
- Employee scheduling and coordination
- Office space optimization
- Cross-platform support (android, iOS)
- Secure authentication and authorization
- Real-time updates and notifications
## Goal :dart:
The main goal of the project is the automation of various processes in the office and providing
interesting statistics for employees.
## Technical goal: :wrench:
The main technical task of the project is to create a multi-module application on Kotlin,
trying to focus on the most modern and relevant solutions in this language. Throughout the project,
we tried to use other languages and
technologies as little as possible.
## 📺 Features: (Meeting Room Tablet App)
<img src="media/tablet/demo-tablet.gif" style="height: 50%;" />
### 🔧 Features Overview
| Feature | Description |
|----------------------------|--------------------------------------------------------------|
| Real-time Availability | Displays up-to-date status of meeting rooms |
| Quick Booking | Instantly reserve an available room with a single tap |
| Time-Specific Reservations| Book rooms for specific time slots |
| Booking Cancellation | Cancel existing reservations with ease |
| Early Room Release | Free up the room before the end of the reservation |
| Google Calendar Integration| Syncs all bookings with Google Calendar |
## Architecture
The project follows a client-server architecture:
- **Backend**: Spring Boot application with PostgreSQL database
- **Clients**: Client applications and iOS tablet app
- **Deployment**: Docker-based containerization for easy deployment
......@@ -20,15 +40,17 @@ The project follows a client-server architecture:
## Getting Started
### Prerequisites
- Git
- Docker and Docker Compose
- JDK 17 or higher
- Gitleaks (for development)
### Installation
1. Clone the repository:
```
git clone https://github.com/your-organization/effective-office.git
git clone https://github.com/effective-dev-opensource/Effective-Office
cd effective-office
```
......@@ -51,13 +73,14 @@ The project follows a client-server architecture:
```
## Project Structure
```
effective-office/
├── backend/ # Server-side application
│ └── README.md # Detailed backend documentation
├── clients/ # Client applications
│ └── README.md # Detailed client documentation
├── iosApp/ # iOS mobile application
├── iosApp/ # iOS tablet application
├── deploy/ # Deployment configurations
│ ├── dev/ # Development environment
│ └── prod/ # Production environment
......@@ -68,37 +91,39 @@ effective-office/
```
For detailed documentation:
- [Backend Documentation](./backend/README.md)
- [Client Documentation](./clients/README.md)
- [Build Logic Documentation](./build-logic/README.md)
- [Calendar Integration Documentation](docs/CALENDAR_INTEGRATION.md)
## Development Tools
- **Build System**: Gradle with Kotlin DSL
- **Containerization**: Docker and Docker Compose
- **Security Scanning**: Gitleaks for secret detection
- **CI/CD**: Automated build and deployment pipelines
- **Version Control**: Git with pre-commit hooks
## Code Style & Conventions
- Follow Kotlin coding conventions for backend development
- Use consistent naming patterns across the codebase
- Document public APIs and complex logic
- Run the pre-commit hook to ensure no secrets are committed
## Contributing
1. Ensure you've run the installation script (`./scripts/install.sh`)
2. Follow our [Git Flow](docs/GIT_FLOW.md) for branching and commit conventions
3. Create a feature branch (`git checkout -b feature/amazing-feature`)
4. Commit your changes (`git commit -m 'Add some amazing feature'`)
5. Push to the branch (`git push origin feature/amazing-feature`)
6. Open a Pull Request
## Contributing :raised_hands:
Our project is open-source, so we welcome quality contributions! To make your contribution to the
project efficient and easy to check out, you can familiarize yourself with the project's [git flow
and commit rules](docs/GIT_FLOW.md). If you want to solve an existing issue in the project, you can read the list in
the issues tab in the repository.
## Roadmap
- TODO
- 📺 A TV application is in development, featuring a corporate news and photo feed, event announcements with registration
from an external service, Duolingo and sports leaderboards, and a tracker for the internal currency.
## Authors :writing_hand:
## Authors
- TODO
- [Stanislav Radchenko](https://github.com/Radch-enko)
- [Vitaly Smirnov](https://github.com/KrugarValdes)
## License
- TODO
Этот изменения образа не может быть отображен по слишком большой. Вместо этого вы можете использовать просмотреть бинарные данные
Поддерживает Markdown
0% или .
You are about to add 0 people to the discussion. Proceed with caution.
Сначала завершите редактирование этого сообщения!
Пожалуйста, зарегистрируйтесь или чтобы прокомментировать