Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/4lessandrodev/calendar

The Configurable Calendar Lib is a versatile library for creating and managing customizable calendars. With a hierarchical tree structure, it enables intuitive navigation from yearly overviews to specific time slots. Whether setting up daily, weekly, or recurring schedules, this library offers flexibility and precision. Ideal for developers focused
https://github.com/4lessandrodev/calendar

calendar configurable event-organization hierarchical-structure library recurring-events scheduling time-management time-slots weekly-planning yearly-overview

Last synced: about 1 month ago
JSON representation

The Configurable Calendar Lib is a versatile library for creating and managing customizable calendars. With a hierarchical tree structure, it enables intuitive navigation from yearly overviews to specific time slots. Whether setting up daily, weekly, or recurring schedules, this library offers flexibility and precision. Ideal for developers focused

Awesome Lists containing this project

README 

        
# Configurable Calendar Lib



[Portuguese Version](./LEIAME.md)



The **Configurable Calendar Lib** is a library developed to facilitate the creation and manipulation of personalized calendars. With a well-defined tree structure, it allows for intuitive and flexible navigation from the year level down to the time slots.



## Tree Structure



The library operates on a hierarchical tree structure as follows:



- **Year**: Each year can be configured and will point to months.

- **Month**: Within a year, each month contains weeks.

- **Week**: Each week has days.

- **Day**: Each day is subdivided into hours.

- **Hour**: Within a day, each hour contains time slots.



This tree structure enables clear and efficient organization of events and information over time.



```mermaid

    graph TD

    A[Configurable Calendar] --> B[Year]

    B --> C[Month]

    C --> D[Week]

    D --> E[Day]

    E --> F[Hour]

    F --> G[Time Slot]

    B --> H[...]

    C --> I[...]

    D --> J[...]

    E --> K[...]

    F --> L[...]

    G --> M[...]

```



## Key Features



### Calendar Creation



With the **Configurable Calendar Lib**, you can create calendars in various ways:



1. **For All Days**: Set the start date, end date, start time, end time, and slot duration for every day.

2. **For Specific Days**: Set the start date, end date, and choose specific weekdays (Monday, Tuesday, etc.) and set the start time, end time, and slot duration for each of these days.

3. **At Specific Intervals**: Configure the calendar for specific days (e.g., every 15 days, 30 days) from an initial date, defining the start time, end time, slot duration and end date.



#### Create Config for all days



The flow represents a structured sequence for setting up a customized calendar. Starting with the selection of the year and defining start and end dates, the process moves on to configure the calendar for all days. Subsequently, start and end times are specified, culminating in setting the slot duration. The flow concludes with a review and confirmation of the settings, ensuring all information is correct before finalizing the calendar configuration.



```mermaid

graph TD

    A[Start Configuration] --> B[Choose Year]

    B --> C[Select Start Date]

    C --> D[Select End Date]

    D --> E[All Days]

    E --> F1[Specify Start Time]

    F1 --> F2[Specify End Time]

    F2 --> G[Specify Slot Duration]

    G --> H[Review and Confirm]

    H --> I[End Configuration]

```



#### For Specifics Days



The flow outlines a structured process tailored for setting up a calendar based on specific days of the week. Beginning with the selection of a year and determining start and end dates, the configuration narrows down to choosing particular weekdays. Following this, individual start and end times are set for each selected day. Subsequently, the slot duration for each specific day is specified. The process culminates with a review and confirmation step, ensuring accurate settings before finalizing the calendar configuration.



```mermaid

graph TD

    A[Start Configuration] --> B[Choose Year]

    B --> C[Select Start Date]

    C --> D[Select End Date]

    D --> E[Choose Week Days]

    E --> F1[Specify Start Time for each day]

    F1 --> F2[Specify End Time for each day]

    F2 --> G[Specify Slot Duration for each]

    G --> H[Review and Confirm]

    H --> I[End Configuration]

```



#### At Specific Intervals



The flow diagram delineates a structured procedure for setting up a calendar based on specific intervals. Initiated by selecting a year and determining the start and end dates, the configuration then focuses on choosing a particular interval. Subsequent steps involve specifying the start and end times for this interval. Following this, the slot duration for each period is defined. The sequence concludes with a review and confirmation phase, ensuring precise configurations before finalizing the calendar 



```mermaid

graph TD

    A[Start Configuration] --> B[Choose Year]

    B --> C[Select Start Date]

    C --> D[Select End Date]

    D --> E[Choose Interval]

    E --> F1[Specify Start Time]

    F1 --> F2[Specify End Time]

    F2 --> G[Specify Slot Duration for each]

    G --> H[Review and Confirm]

    H --> I[End Configuration]

```



## Getting Started



To begin using the library, refer to the documentation and available examples. Integration is straightforward and flexible, allowing you to tailor the library to the specific needs of your project.



---



We hope the **Configurable Calendar Lib** meets your time management and event organization needs. Feel free to contribute, report issues, or send suggestions for improvement.