Add final stuff
This commit is contained in:
60
README.md
60
README.md
@@ -1,6 +1,10 @@
|
||||
# Stretch My Time Off
|
||||
|
||||
Welcome to **Stretch My Time Off**, a personal project designed to help you optimize your vacation days by strategically aligning public holidays and personal leave. This tool allows you to maximize your time off.
|
||||
**Stretch My Time Off** is a tool designed to help you optimize your vacation days by aligning public holidays and personal leave. This project was generated entirely with ChatGPT in a code editor designed for AI-assisted development.
|
||||
|
||||
Website: https://stretchmytimeoff.com
|
||||
|
||||

|
||||
|
||||
## Table of Contents
|
||||
|
||||
@@ -9,20 +13,21 @@ Welcome to **Stretch My Time Off**, a personal project designed to help you opti
|
||||
- [Tech Stack](#tech-stack)
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
- [Algorithm](#algorithm)
|
||||
- [Contributing](#contributing)
|
||||
- [License](#license)
|
||||
- [Acknowledgments](#acknowledgments)
|
||||
|
||||
## About the Project
|
||||
|
||||
I created this project out of a personal need to better manage vacation days. As someone who loves to travel, I wanted a tool that could help me make the most of my time off by aligning it with public holidays. This project was coded using the Cursor IDE with the assistance of GPT-4o, and it is hosted on Vercel with Cloudflare providing additional services.
|
||||
This project was created to efficiently manage vacation days by aligning them with public holidays. It was developed using the Cursor IDE with GPT-4o and is hosted on Vercel with Cloudflare.
|
||||
|
||||
## Features
|
||||
|
||||
- **Country-Specific Holidays**: Automatically fetches public holidays for your country.
|
||||
- **Optimized Days Off**: Calculates the best way to use your personal leave days to maximize time off.
|
||||
- **Interactive Calendar**: Visualize your holidays and optimized days off in a user-friendly calendar.
|
||||
- **Responsive Design**: Works seamlessly on both desktop and mobile devices.
|
||||
- **Country-Specific Holidays**: Fetches public holidays for your country.
|
||||
- **Optimized Days Off**: Calculates the best use of personal leave days.
|
||||
- **Interactive Calendar**: Visualizes holidays and optimized days off.
|
||||
- **Responsive Design**: Compatible with desktop and mobile devices.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
@@ -35,8 +40,6 @@ I created this project out of a personal need to better manage vacation days. As
|
||||
|
||||
## Installation
|
||||
|
||||
To get a local copy up and running, follow these steps:
|
||||
|
||||
1. **Clone the repository**:
|
||||
```bash
|
||||
git clone https://github.com/yourusername/stretch-my-time-off.git
|
||||
@@ -59,24 +62,17 @@ To get a local copy up and running, follow these steps:
|
||||
|
||||
## Usage
|
||||
|
||||
Once the development server is running, you can access the application at `http://localhost:3000`. Enter your country to see the public holidays and use the interactive calendar to plan your time off.
|
||||
|
||||
Access the application at `http://localhost:3000`. Enter your country to view public holidays and plan your time off using the interactive calendar.
|
||||
|
||||
## Algorithm
|
||||
|
||||
The core of this project is an algorithm that optimizes your personal leave days to create the longest possible chains of consecutive days off. Here's a simplified explanation:
|
||||
The algorithm optimizes personal leave days to maximize consecutive days off:
|
||||
|
||||
1. **Identify Public Holidays and Weekends**: The algorithm first identifies all public holidays and weekends for the selected year and country.
|
||||
|
||||
2. **Find Gaps**: It then finds gaps between these days off that can be filled with personal leave days.
|
||||
|
||||
3. **Rank Gaps**: The gaps are ranked based on their efficiency in creating longer chains of days off.
|
||||
|
||||
4. **Select Days Off**: The algorithm selects the most efficient gaps to fill with your available personal leave days.
|
||||
|
||||
5. **Calculate Consecutive Days Off**: Finally, it calculates the total number of consecutive days off you can achieve.
|
||||
|
||||
Here's a visual representation of the algorithm using a Mermaid diagram:
|
||||
1. **Identify Public Holidays and Weekends**.
|
||||
2. **Find Gaps** between these days.
|
||||
3. **Rank Gaps** by efficiency.
|
||||
4. **Select Days Off** to fill gaps.
|
||||
5. **Calculate Consecutive Days Off**.
|
||||
|
||||
```mermaid
|
||||
graph TD;
|
||||
@@ -90,13 +86,7 @@ graph TD;
|
||||
|
||||
## Contributing
|
||||
|
||||
Contributions are welcome! If you have suggestions for improvements or new features, feel free to open an issue or submit a pull request.
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
Contributions are welcome! Open an issue or submit a pull request for improvements or new features.
|
||||
|
||||
## License
|
||||
|
||||
@@ -104,7 +94,11 @@ Distributed under the MIT License. See `LICENSE` for more information.
|
||||
|
||||
## Acknowledgments
|
||||
|
||||
- **SvelteKit**: For providing a powerful and flexible framework.
|
||||
- **Vercel**: For seamless deployment and hosting.
|
||||
- **Cloudflare**: For robust CDN and security features.
|
||||
- **Cursor IDE and GPT-4o**: For making the development process efficient and enjoyable.
|
||||
- **SvelteKit**: For the framework.
|
||||
- **Vercel**: For hosting.
|
||||
- **Cloudflare**: For CDN and security.
|
||||
- **Cursor IDE and GPT-4o**: For development assistance.
|
||||
|
||||
---
|
||||
|
||||
**Disclaimer**: This project was 100% generated with ChatGPT out of pure interest, using a code editor designed for AI-assisted development.
|
||||
|
||||
BIN
screenshot.png
Normal file
BIN
screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 244 KiB |
Reference in New Issue
Block a user