{"id":21043412,"url":"https://github.com/crystallizeapi/node-js-ts-frontend-and-service-api-project-starter-kit","last_synced_at":"2026-04-02T02:47:32.554Z","repository":{"id":60180133,"uuid":"481411075","full_name":"CrystallizeAPI/node-js-ts-frontend-and-service-api-project-starter-kit","owner":"CrystallizeAPI","description":"Starter Kit for Frontend (of your choice) and Service API with Node, TypeScript and more","archived":false,"fork":false,"pushed_at":"2022-04-14T00:09:04.000Z","size":5,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-20T17:24:12.640Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://crystallize.com","language":"Makefile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CrystallizeAPI.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":null,"support":null}},"created_at":"2022-04-14T00:08:47.000Z","updated_at":"2024-06-07T14:06:16.000Z","dependencies_parsed_at":"2022-09-26T11:00:22.461Z","dependency_job_id":null,"html_url":"https://github.com/CrystallizeAPI/node-js-ts-frontend-and-service-api-project-starter-kit","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrystallizeAPI%2Fnode-js-ts-frontend-and-service-api-project-starter-kit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrystallizeAPI%2Fnode-js-ts-frontend-and-service-api-project-starter-kit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrystallizeAPI%2Fnode-js-ts-frontend-and-service-api-project-starter-kit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CrystallizeAPI%2Fnode-js-ts-frontend-and-service-api-project-starter-kit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CrystallizeAPI","download_url":"https://codeload.github.com/CrystallizeAPI/node-js-ts-frontend-and-service-api-project-starter-kit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243489809,"owners_count":20298997,"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":[],"created_at":"2024-11-19T14:12:42.988Z","updated_at":"2025-12-28T15:59:34.414Z","avatar_url":"https://github.com/CrystallizeAPI.png","language":"Makefile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BEFORE TO USE, DO THIS RIGHT AFTER YOU CLONE\n\n- the Frontend folder is empty, you decide the framework you want for your Frontend, on our side we like them all, with a preference for Remix Run those days.\n\n- Replace `service-api.domain.name` and `frontend.domain.name` by the domains you want for your local development\n    - in this file (README.md)\n    - in the `provisioning/dev/Caddyfile`\n    - in the `Makefile`\n    - add the domains in your `/etc/hosts` (as mentioned in the provided documentation below)\n\nThat's it:! Then you can run\n```bash\nmake install\nmake serve\n```\n\n- Remove this section from this file (README.md)\n\n\n# Project [NAME]\n\nThis repository handles:\n\n-   the Frontend using [FRONTEND FRAMEWORK]\n-   the Service API using Koa\n\n# Requirements\n\n-   Docker\n-   Volta.sh (that will bring good version of Node)\n-   Caddy Server v2\n-   `mkcert` for https with local domains\n\n\u003e You need this install on your computer to leverage the Makefile automation\n\n## Domains\n\nWe want to respect as much a possible the Twelve-Factor App, especially https://12factor.net/dev-prod-parity\n\nIt means we want HTTPS locally and custom domains locally as well.\n\nAdd an entry in your `/etc/hosts`\n\n```\n127.0.0.1 service-api.domain.name frontend.domain.name\n```\n\n\u003e All the automation are prepared to work with service-api.domain.name and frontend.domain.name\n\n# Installation\n\n```bash\nmake install\n```\n\nThis will:\n\n-   install the Certificate Authority using `mkcert`\n-   generate the certificates for the domains\n-   `npm install` the `front-end` folder and `service-api` folder\n\n# Run the project\n\n```bash\nmake serve\n```\n\nThis will:\n\n-   run the `front-end` and `service-api` projects on HTTP\n-   run the Caddy proxy on HTTPS\n-   run the Docker Network\n\n\u003e you can stop non stopped services with `make stop`\n\n-   Frontend: https://frontend.domain.name\n-   Service API: https://service-api.domain.name\n-   Mailcatcher: http://localhost:42180\n\n# Gotchas\n\n-   Frontend run in HTTP on 42080\n-   Service API run in HTTP on 42081\n-   Caddy enables HTTPS on top of them all\n-   Mailcatcher is on the side up via Docker\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrystallizeapi%2Fnode-js-ts-frontend-and-service-api-project-starter-kit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcrystallizeapi%2Fnode-js-ts-frontend-and-service-api-project-starter-kit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcrystallizeapi%2Fnode-js-ts-frontend-and-service-api-project-starter-kit/lists"}