Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/layer-se7en/fp-g2s
https://github.com/layer-se7en/fp-g2s
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/layer-se7en/fp-g2s
- Owner: layer-se7en
- License: agpl-3.0
- Created: 2023-11-19T06:13:48.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-03T01:35:13.000Z (about 1 year ago)
- Last Synced: 2024-12-31T03:29:32.501Z (10 days ago)
- Language: C++
- Size: 75.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# README
# Ticket Booker Application
## Introduction
The Ticket Booker Application is a command-line application that enables customers to book tickets for events and event managers to create new events. This documentation provides an overview of the application's functionality, code structure, and usage.
## Key Features
- Booking tickets for events.
- Creating new events with customizable seating arrangements.
- Managing ticket data and event information.
## Usage
To use the Ticket Booker Application, you have two options:
1. **Online Version**: Visit our online version at [Ticket Booker on Replit](https://replit.com/@eliasbnk/fp-g2s).
2. **Download and Run Locally**:
- Download the source code from [GitHub](https://github.com/eliasbnk/fp-g2s/archive/refs/heads/main.zip).
- Unzip the downloaded file.
- Ensure your compiler is using **C++ version 17 or higher**.
- Compile and run the application.
**Warning**: If you download the source code, ensure that your compiler is using **C++ version 17 or higher**, or the application will not function correctly.
## Authors
- ROBERT MURDOCH
- SYED SHAH
- TSELMEN ANUURAD
- IVAN BENEDYCHUK
- JACOB JACKMAN
- ILYA BABENKO
## License
This project is licensed under the GNU Affero General Public License (AGPL). See the LICENSE file for details.
---
# Naming Conventions
## Crucial Constants
- **Convention**: CamelCase
- **Prefix**: 'k'
- **Example**: `kVariableName`
- **Location**: Shared directory
## Reusable Types
- **Convention**: CamelCase
- **Prefix**: 't'
- **Example**: `tStringVector`
- **Location**: Shared directory/types.hpp
## Regular Variables
- **Convention**: snake_case
- **Example**: `variable_name`
- **Clarity**: Use clear, descriptive names.
- *Including regular constant variables*
## Functions/Modules
- **Convention**: PascalCase
- **Explanation**: First word describes action.
- **Examples**: `GetVenueSize`, `Get`, `Draw`, `Print`, `Create`, `Generate`, `Validate`, etc.
- **Boolean Functions**: Start with 'Is', framed as questions.
- **Example**: `IsValidNumber` (returns true/false)
# Directory Structure
- **Booking Menu**: Code related to booking menu.
- **Creator Menu**: Code for event creation menu.
- **Utils**: Functions shared across the project.
- **Shared**: Shared key data.
- **Event Data**: Data for events:
- `check_in_data`: Holds attendee info
- `sold_data`: Holds seat status
- `map_data`: Venue seating info
- `name_data`: Bookers' names
- `price_data`: Seat prices
- `ticket_data`: Bookers' ticket numbers