{"id":21518713,"url":"https://github.com/halo-lab/settimeout","last_synced_at":"2025-08-26T20:17:03.250Z","repository":{"id":125834168,"uuid":"422625880","full_name":"Halo-Lab/settimeout","owner":"Halo-Lab","description":"Email builder for Halo Lab mailing list.","archived":false,"fork":false,"pushed_at":"2022-08-25T18:16:50.000Z","size":2957,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-03-17T16:52:08.960Z","etag":null,"topics":["edelweiss","email","ssg"],"latest_commit_sha":null,"homepage":"https://www.settimeout.dev/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Halo-Lab.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-29T15:29:30.000Z","updated_at":"2022-08-04T06:44:15.000Z","dependencies_parsed_at":"2023-08-13T01:34:32.907Z","dependency_job_id":null,"html_url":"https://github.com/Halo-Lab/settimeout","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Halo-Lab/settimeout","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Halo-Lab%2Fsettimeout","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Halo-Lab%2Fsettimeout/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Halo-Lab%2Fsettimeout/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Halo-Lab%2Fsettimeout/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Halo-Lab","download_url":"https://codeload.github.com/Halo-Lab/settimeout/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Halo-Lab%2Fsettimeout/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272253256,"owners_count":24900868,"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","status":"online","status_checked_at":"2025-08-26T02:00:07.904Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["edelweiss","email","ssg"],"created_at":"2024-11-24T00:53:41.912Z","updated_at":"2025-08-26T20:17:03.239Z","avatar_url":"https://github.com/Halo-Lab.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SetTimeout.dev - the Halo Lab's mailing list\n\nThis project helps create mailing list.\n\n## Requirements\n\n1. Latest LTS version of NodeJS\n2. `npm` \u003e= 7\n\n## Usage\n\nAt first, add JSON with data to the `data` folder. The name of the file should match a date of the mail creation in the\nformat of `Day-Month-Year`.\n\nThe email structure is described in `/shared/types.ts` file.\n\n\u003e Issue number and issue date will be generated automatically (the issue number is the number of json-files in the\n\u003e data folder, date is the name of json-file).\n\n\u003e To add a mailing letter header, you need to fill in the \"greetingTitle\" and \"greetingSubtitle\" fields in the\n\u003e json-file.\n\nThere are only four tags recognizable now (see `Tag` type). If you need to add more, then edit `shared/assets/index.ts`\nfile and add corresponding images.\n\nAvailable titles to which icons will be automatically added: \"Вёрстка\" | \"JavaScript\" | \"Веб-разработка\" | \"Фреймворки\nи библиотеки\" | \"Психология, продуктивность, soft skills\". If you need to add more, then edit `shared/assets/index.ts`\nfile and add corresponding image.\n\n#### Images\n\nAll images are located in `/shared/assets` folder. There is `index.ts` file that contains functions to get the image URL\ndepending on current environment. It is designed to work both for emails and the landing. Please, edit that file when\nyou add a new image or remove some.\n\n### Build\n\nTo build an email for the most recent JSON file type execute:\n\n```shell\nmake build_email \u0026\u0026 node dist/index.js\n```\n\nAn `email.html` file will be generated in _dist_ folder.\n\nTo develop an email page run:\n\n```shell\nmake email_dev\n```\n\nAnd then in separate terminal window run:\n\n```shell\nnode dist/index.js \u0026\u0026 open dist/email.html\n```\n\nAnd you can preview email UI in the browser. **Do not forget to rerun last commands after any change in the code.**\n\nTo develop landing page for the mailing list type run:\n\n```shell\nnpx netlify dev\n```\n\nTo build site run:\n\n```shell\nmake build_site\n```\n\n### Site\n\nThe main source of the site is settled in `app` folder. While extending site's functionality, you should avoid writing\nthere the code that should be run only on the server. There is a possibility to do it, but you should be confident that\nserver's code will be removed from final bundle as `App` and `Head` templates will be invoked in browser environment also.\n\n`server` directory contains server's code only. Files with `.api.` suffix are treated differently. They are standalone\nendpoints and are bundled as separate serverless functions. Other files are helpers, that's why you can create any structure\nthat comes to your mind there.\n\n\u003e `index.api.ts` is the main endpoint and therefore shouldn't be deleted or renamed.\n\n`public` folder will be published to Netlify. So, if there is a need to include some static asset to application (for\nexample, fonts), you can place it there. Public path for those assets should start from `public` folder. For example,\npublic path for _favicon.ico_ image is `/favicon.ico`.\n\n### Email\n\nAll source code is settled in `email` folder. There aren't any restrictions on organising folder structure.\n\n### Shared\n\nAny shared code between email and site should be placed in `shared` folder.\n\n### Assets\n\nAs you can see, any asset can be imported in JS. Bundler will handle them.\n\n### Env\n\nThere should be `.env` file with next variables:\n\n1. DOMAIN=\u003csite's domain name\u003e\n2. LIST_ID=\u003cvalue\u003e\n3. GTAG_ID=\u003cvalue\u003e\n4. BASE_NETLIFY_URL=\u003cvalue\u003e\n5. UNISENDER_API_KEY=\u003cvalue\u003e\n6. UNISENDER_BASE_URL=\u003cvalue\u003e\n\nUse of these variables vary by the environment:\n\n- on the server reach them by `env.DOMAIN` (do not forget to include `import { env } from 'process';`)\n- on the client react them by `import.meta.env.DOMAIN`.\n\nNot all variables are visible on the client. Only those declared in `rollup.common.config.js`. So, if you need to\nadd new one you should add it there and write type for that variable in `global.d.ts` file.\n\n### Simemap updates\n\nRemember to update the `sitemap.xml` file every time you add a new letter. It is necessary to inform Google about the new content issue, and you can do it with updated and actual `sitemap.xml`. To update it, run:\n\n```\n make build_sitemap\n```\n \n Then push updated `sitemap.xml` to the repository.\n\n\n## Word from authors\n\nHave fun ✌️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalo-lab%2Fsettimeout","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhalo-lab%2Fsettimeout","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhalo-lab%2Fsettimeout/lists"}