{"id":18634367,"url":"https://github.com/simhub/simhub-electron-calendar","last_synced_at":"2025-04-11T07:33:12.642Z","repository":{"id":46827630,"uuid":"214869057","full_name":"SimHub/simhub-electron-calendar","owner":"SimHub","description":"Unofficial  Tui-calendar wrapper for electron 🤭 support: win, mac, raspberry pi","archived":false,"fork":false,"pushed_at":"2022-02-28T16:09:23.000Z","size":8793,"stargazers_count":15,"open_issues_count":2,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T11:11:19.258Z","etag":null,"topics":["bootstrap","calendar","electron","electron-app","electron-builder","javascript","momentjs","tui-calendar"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SimHub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2019-10-13T18:09:02.000Z","updated_at":"2024-10-20T14:13:57.000Z","dependencies_parsed_at":"2022-08-27T19:10:37.273Z","dependency_job_id":null,"html_url":"https://github.com/SimHub/simhub-electron-calendar","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimHub%2Fsimhub-electron-calendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimHub%2Fsimhub-electron-calendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimHub%2Fsimhub-electron-calendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SimHub%2Fsimhub-electron-calendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SimHub","download_url":"https://codeload.github.com/SimHub/simhub-electron-calendar/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358874,"owners_count":21090447,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bootstrap","calendar","electron","electron-app","electron-builder","javascript","momentjs","tui-calendar"],"created_at":"2024-11-07T05:18:23.606Z","updated_at":"2025-04-11T07:33:11.322Z","avatar_url":"https://github.com/SimHub.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"#  \u003cimg src=\"./resources/icons/512x512.png\" alt=\"electron-calendar\" width=\"100\"/\u003e  simhub-electron-calendar \n    unofficial Tui-calendar wrapper for electron 🤭 \n\n \n![GitHub commit activity](https://img.shields.io/github/commit-activity/m/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub\ncontributors](https://img.shields.io/github/contributors/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub All Releases](https://img.shields.io/github/downloads/simhub/simhub-electron-calendar/total?style=for-the-badge)\n![GitHub followers](https://img.shields.io/github/followers/simhub?style=for-the-badge)\n![GitHub forks](https://img.shields.io/github/forks/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub stars](https://img.shields.io/github/stars/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub language count](https://img.shields.io/github/languages/count/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub search hit counter](https://img.shields.io/github/search/simhub/simhub-electron-calendar/goto?style=for-the-badge)\n![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub repo size](https://img.shields.io/github/repo-size/simhub/simhub-electron-calendar?style=for-the-badge)\n![GitHub issues](https://img.shields.io/github/issues/simhub/simhub-electron-calendar?style=for-the-badge)\n\n\n \u003cimg src=\"./src/images/calendar.png\" alt=\"electron-calendar\"/\u003e  \n\n\u003cbr\u003e\n\u003cbr\u003e\n\n # \u003cimg src=\"./resources/icons/512x512.png\" alt=\"electron-calendar\" width=\"30\"/\u003e  Download App \n\n\n \u003ca href=\"https://github.com/SimHub/simhub-electron-calendar/releases\"\n al=\"app\"\u003e\u003cem style=\"vertical-align: 18px;\"\u003e - Download built\n binaries from the releases section\u003c/em\u003e \u003c/a\u003e \n\n\u003cbr\u003e\n\n# For Developers  \n\n## ToastUi calendar \n\n\u003ca href=\"https://github.com/nhn/tui.calendar\"\u003etui-calendar\u003c/a\u003e \n\n## Electron  \n\n### Quick start\n\nMake sure you have [Node.js](https://nodejs.org) installed, then type the following commands known to every Node developer...\n```\ngit clone https://github.com/SimHub/simhub-electron-calendar.git\ncd /simhub-electron-calendar/\nnpm install\nnpm start\n```\n...and you have a running desktop application on your screen.\n\n# Structure of the project\n\nThe application consists of two main folders...\n\n`src` - files within this folder get transpiled or compiled (because Electron can't use them directly).\n\n`app` - contains all static assets which don't need any pre-processing. Put here images, CSSes, HTMLs, etc.\n\nThe build process compiles the content of the `src` folder and puts it into the `app` folder, so after the build has finished, your `app` folder contains the full, runnable application.\n\nTreat `src` and `app` folders like two halves of one bigger thing.\n\nThe drawback of this design is that `app` folder contains some files which should be git-ignored and some which shouldn't (see `.gitignore` file). But this two-folders split makes development builds much, much faster.\n\n# Development\n\n## Starting the app\n\n```\nnpm start\n```\n\n## The build pipeline\n\nBuild process uses [Webpack](https://webpack.js.org/). The entry-points are `src/background.js` and `src/app.js`. Webpack will follow all `import` statements starting from those files and compile code of the whole dependency tree into one `.js` file for each entry point.\n\n[Babel](http://babeljs.io/) is also utilised, but mainly for its great error messages. Electron under the hood runs latest Chromium, hence most of the new JavaScript features are already natively supported.\n\n## Environments\n\nEnvironmental variables are done in a bit different way (not via `process.env`). Env files are plain JSONs in `config` directory, and build process dynamically links one of them as an `env` module. You can import it wherever in code you need access to the environment.\n```js\nimport env from \"env\";\nconsole.log(env.name);\n```\n\n## Upgrading Electron version\n\nTo do so edit `package.json`:\n```json\n\"devDependencies\": {\n  \"electron\": \"2.0.2\"\n}\n```\n*Side note:* [Electron authors recommend](http://electron.atom.io/docs/tutorial/electron-versioning/) to use fixed version here.\n\n## Adding npm modules to your app\n\nRemember to respect the split between `dependencies` and `devDependencies` in `package.json` file. Your distributable app will contain modules listed in `dependencies` after running the release script.\n\n*Side note:* If the module you want to use in your app is a native one (not pure JavaScript but compiled binary) you should first  run `npm install name_of_npm_module` and then `npm run postinstall` to rebuild the module for Electron. You need to do this once after you're first time installing the module. Later on, the postinstall script will fire automatically with every `npm install`.\n\n# Testing\n\nRun all tests:\n```\nnpm test\n```\n\n## Unit\n\n```\nnpm run unit\n```\nUsing [electron-mocha](https://github.com/jprichardson/electron-mocha) test runner with the [Chai](http://chaijs.com/api/assert/) assertion library. You can put your spec files wherever you want within the `src` directory, just name them with the `.spec.js` extension.\n\n## End to end\n\n```\nnpm run e2e\n```\nUsing [Mocha](https://mochajs.org/) and [Spectron](http://electron.atom.io/spectron/). This task will run all files in `e2e` directory with `.e2e.js` extension.\n\n# Making a release\n\nTo package your app into an installer use command:\n```\nnpm run release\n```\n\nOnce the packaging process finished, the `dist` directory will contain your distributable file.\n\nWe use [electron-builder](https://github.com/electron-userland/electron-builder) to handle the packaging process. It has a lot of [customization options](https://www.electron.build/configuration/configuration), which you can declare under `\"build\"` key in `package.json`.\n\nYou can package your app cross-platform from a single operating system, [electron-builder kind of supports this](https://www.electron.build/multi-platform-build), but there are limitations and asterisks. That's why this boilerplate doesn't do that by default.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimhub%2Fsimhub-electron-calendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimhub%2Fsimhub-electron-calendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimhub%2Fsimhub-electron-calendar/lists"}