Create your own version of a Dot Calendar
dot-calendar
dot-calendar
is a tool that allows anyone who loves dot calendars to create their own versions of the calendar.
The project was born because I like to have a physical calendar in addition to my digital calendar, where I can see at a glance what is scheduled and when. By chance I came across the dot calendar style and decided that I would like to have my own version of it. To avoid having to create a new vector graphic every year, I solved it programmatically.
Before you begin, ensure you have met the following requirements:
That’s it ;) Admittedly, I didn’t test the project on Windows, but it runs fine on Ubuntu and Mac.
dot-calendar
Install all dependencies with
npm install
For a quick start, there are sample configurations in the config
directory, such as contemporary-and-bold.json.
To create calendars from the sample configurations simply run the following command:
npm run start
# adjust ./src/utils/config-creator.ts
npm run generate:config
It is easy to create your own versions of the calendar. All you have to do is make some configurations.
The basis is a config.json
, in which color information, number of columns, year, distances etc. are configured. The interface is here.
Example:
{
"title": "contemporary-and-bold",
"year": 2020,
"language": "DE",
"weekendColor": "#4E4E50",
"general": {
"width": 4961,
"height": 3508,
"textDistance": 100,
"widthBuffer": 100,
"bgColor": "#1A1A1D",
"textFont": "Helvetica",
"textColor": "#FFFFFF"
},
"dots": {
"distanceBetweenCirclesX": 5,
"distanceBetweenCirclesY": 5,
"columns": 3,
"dotStrikeColor": "#950740",
"dotLineWidth": 10
}
}
In addition to the basic information, dots can be marked with colors. This is useful for school holidays, bank holidays, birthdays, etc. that are already known in advance. For this purpose *.flag.json
files are configured. The payload is very simple - just use the examples if necessary.
In summary: create your configuration file, follow the instructions in index.ts
and run npm run start
to get your own calendar. Have fun!
Here is an example with 5 instead of 3 columns per month and adjusted distances for the year 2099. This can be done by simply changing the columns
and distanceBetweenCirclesY
values.
dot-calendar
To contribute to dot-calendar
, follow these steps:
git checkout -b <branch_name>
.git commit -m '<commit_message>'
git push origin urbanisierung/dot-calendar
Alternatively see the GitHub documentation on creating a pull request.
If you want to contact me you can reach me at adam.urban@gmail.com.
This project uses the following license: MIT.