Update readme
This commit is contained in:
54
README.md
54
README.md
@@ -12,12 +12,16 @@ This is a Python application for managing Crossfit bookings and notifications. T
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Docker
|
||||
- Docker Compose
|
||||
- Python 3.8+
|
||||
- Docker (optional)
|
||||
- Docker Compose (optional)
|
||||
|
||||
## Setup
|
||||
|
||||
1. Create a `.env` file based on `.env.example` and fill in the required credentials.
|
||||
|
||||
### Running with Docker (Recommended)
|
||||
|
||||
2. Build and run the application using Docker Compose:
|
||||
|
||||
```bash
|
||||
@@ -26,6 +30,20 @@ docker-compose up --build
|
||||
|
||||
3. The application will run in a Docker container, and the logs will be stored in the `./log` directory.
|
||||
|
||||
### Manual Setup
|
||||
|
||||
2. Install dependencies:
|
||||
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. Run the application:
|
||||
|
||||
```bash
|
||||
python main.py
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
The application will automatically check for available sessions and book them based on your preferences. It will send notifications via email and Telegram when a booking is successful.
|
||||
@@ -76,32 +94,46 @@ The application will automatically load the preferred sessions from this file. I
|
||||
|
||||
## Files
|
||||
|
||||
- `main.py`: Main entry point for the application
|
||||
- `src/`: Source code directory
|
||||
- `auth.py`: Authentication handling
|
||||
- `booker.py`: Main booking logic
|
||||
- `session_manager.py`: Session management
|
||||
- `session_notifier.py`: Notification handling
|
||||
- `session_config.py`: Session configuration
|
||||
- `tools/`: Utility scripts
|
||||
- `scripts/`: Additional scripts
|
||||
- `test/`: Test files
|
||||
- `Dockerfile`: Docker image definition
|
||||
- `docker-compose.yml`: Docker Compose service definition
|
||||
- `.env.example`: Example environment variables file
|
||||
- `.dockerignore`: Docker ignore file
|
||||
- `.gitignore`: Git ignore file
|
||||
- `book_crossfit.py`: Main application script
|
||||
- `crossfit_booker.py`: Crossfit booking script
|
||||
- `session_notifier.py`: Session notification script
|
||||
- `preferred_sessions.json`: Configuration file for preferred sessions
|
||||
- `preferred_sessions.json.example`: Example configuration file for preferred sessions
|
||||
- `requirements.txt`: Python dependencies
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
.
|
||||
├── main.py
|
||||
├── src/
|
||||
│ ├── auth.py
|
||||
│ ├── booker.py
|
||||
│ ├── session_manager.py
|
||||
│ ├── session_notifier.py
|
||||
│ └── session_config.py
|
||||
├── tools/
|
||||
├── scripts/
|
||||
├── test/
|
||||
├── Dockerfile
|
||||
├── docker-compose.yml
|
||||
├── .env.example
|
||||
├── .dockerignore
|
||||
├── .gitignore
|
||||
├── book_crossfit.py
|
||||
├── crossfit_booker.py
|
||||
├── session_notifier.py
|
||||
├── preferred_sessions.json.example
|
||||
├── requirements.txt
|
||||
├── preferred_sessions.json
|
||||
└── log
|
||||
└── log/
|
||||
└── crossfit_booking.log
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user