{"id":23507373,"url":"https://github.com/simplyhexagonal/create-jscad-project","last_synced_at":"2025-05-12T15:51:07.895Z","repository":{"id":214584981,"uuid":"736803959","full_name":"simplyhexagonal/create-jscad-project","owner":"simplyhexagonal","description":"An npx starter template for JsCad projects using Typescript and Hot Reload preview","archived":false,"fork":false,"pushed_at":"2024-07-15T06:00:57.000Z","size":2331,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-05-06T20:25:36.622Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Vue","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/simplyhexagonal.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,"zenodo":null}},"created_at":"2023-12-28T23:32:01.000Z","updated_at":"2025-02-11T17:54:23.000Z","dependencies_parsed_at":"2025-04-20T12:00:53.355Z","dependency_job_id":null,"html_url":"https://github.com/simplyhexagonal/create-jscad-project","commit_stats":{"total_commits":21,"total_committers":2,"mean_commits":10.5,"dds":0.04761904761904767,"last_synced_commit":"1ba4ba2bd30a9ed65409ff752d85f63c696adfb1"},"previous_names":["simplyhexagonal/create-jscad-project"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyhexagonal%2Fcreate-jscad-project","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyhexagonal%2Fcreate-jscad-project/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyhexagonal%2Fcreate-jscad-project/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simplyhexagonal%2Fcreate-jscad-project/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simplyhexagonal","download_url":"https://codeload.github.com/simplyhexagonal/create-jscad-project/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253524955,"owners_count":21922002,"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-12-25T10:18:17.887Z","updated_at":"2025-05-12T15:51:07.871Z","avatar_url":"https://github.com/simplyhexagonal.png","language":"Vue","funding_links":["https://ko-fi.com/jeanlescure","https://www.patreon.com/jeanlescure"],"categories":[],"sub_categories":[],"readme":"# Create JSCAD Project\n\n## Introduction\n\nAn NPX starter template designed to kickstart your JSCAD projects using TypeScript and Hot Reload preview. This tool simplifies the process of setting up a JSCAD project, allowing you to focus on creating fully parametric CAD drawings with ease.\n\n![Demo GIF](./assets/demo.gif)\n\n## Features\n\n- 🚀 **Easy Setup**: Initialize your JSCAD project with a single command.\n- 💻 **TypeScript Support**: Leverage the power of TypeScript for more robust code.\n- 🔁 **Hot Reload Preview**: Instantly view changes in your CAD design as you code.\n- 🔧 **Automatic Interactive Controls**: If you define parameters in your design, the viewport will render interactive controls that can be changed in the UI.\n- 📁 **Automated Structure and Dependency Management**: Automatically creates the necessary folder structure and installs dependencies.\n- 🎨 **Focus on Design**: Spend more time designing and less on setup.\n- 🛠️ **Integrated VSCode Experience**: Recommended extensions and launch configurations for a seamless development experience.\n- 📤 **Advanced Export Options**: Export your designs to X3D, 3MF, and SVG formats.\n\n## Like this project? ❤\n\nPlease consider:\n\n- [Buying me a coffee](https://ko-fi.com/jeanlescure) ☕\n- Supporting me on [Patreon](https://www.patreon.com/jeanlescure) 🏆\n- Starring this repo on [Github](https://github.com/simplyhexagonal/create-jscad-project) 🌟\n\n## Getting Started\n\n### Prerequisites\n\nEnsure you have Node.js installed on your system to use `npm` or `npx`.\n\n### Installation\n\nTo create a new JSCAD project, run the following command in your terminal:\n\n```bash\nnpm init jscad-project \u003cyour-project-name\u003e\n```\n\nor\n\n```bash\nnpx create-jscad-project \u003cyour-project-name\u003e\n```\n\nThis command will create a new directory with your project name, set up the folder structure, and install all the necessary dependencies.\n\n### Templates\n\nTo use a specific template, pass the `--template` argument when creating a new project. For example:\n\n```bash\nnpm init jscad-project \u003cyour-project-name\u003e -- --template=screw-and-nut\n```\n\nTo list available templates you can run:\n\n```bash\nnpx create-jscad-project --list-templates\n```\n\nThere are currently two templates available:\n\n- `default`: A blank canvas for whatever project you're working on.\n- `screw-and-nut`: Contains a screw and nut for you to play with.\n\nMore templates will be added soon, hopefully by contributors too!\n\n### VSCode Integration\n\n- **Recommended Extensions**: The generated `.vscode` directory contains recommendations for helpful extensions. Please review and install them to enhance your development experience.\n- **Launch Configuration**: Use the \"Launch JSCAD\" configuration in the `Run and Debug` section of VSCode. This will open the `drawing.ts` file, run `npm run dev`, and open the preview browser. \n  - **Note**: The first time you run this, the preview browser may initially display a white screen. Please wait until the debug output indicates that it's safe to reload the simple browser panel.\n\n### Alternatively - Development in other IDEs\n\nIf you are **NOT** using VSCode, or if you'd rather run the dev environment manually, then, after setting up your project, navigate to your project directory and start the development server:\n\n```bash\ncd \u003cyour-project-name\u003e\nnpm run dev\n```\n\n### Preview and Export\n\n- In the preview window, you have the option to export your designs to X3D and 3MF file formats.\n- To export to SVG, project any parts into 2D and ensure the \"Projection\" checkbox is turned on.\n\n## Related Projects and Resources\n\n`create-jscad-project` is built upon and inspired by the capabilities of JSCAD. Here are some resources and related projects that can enhance your experience with JSCAD:\n\n- **JSCAD**: The core framework upon which this project is based. For more information and documentation, visit [JSCAD's Github](https://github.com/jscad/OpenJSCAD.org).\n\n- **JSCAD Cheat Sheet**: A handy guide for quick reference to JSCAD syntax and features. Perfect for beginners and experienced users alike. Check out the [JSCAD Cheat Sheet](https://openjscad.xyz/dokuwiki/doku.php?id=en:jscad_design_guide).\n\n- **Parametric Polysphericon Design Tutorial**: Dive into a practical example of parametric design with JSCAD in this informative YouTube video by CodeDoodle. Watch the [Parametric Polysphericon Design using JSCAD](https://www.youtube.com/watch?v=j0GNx376kcY) for insights and inspiration.\n\n\n## Contributing\n\nContributions are welcome! Feel free to submit pull requests or open issues to improve `create-jscad-project`.\n\n## Contributors\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://github.com/jeanlescure\"\u003e\n        \u003cimg\n          alt=\"jeanlescure\"\n          src=\"https://raw.githubusercontent.com/simplyhexagonal/create-jscad-project/main/assets/contributors/jeanlescure.svg\" width=\"117\"\n        /\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://github.com/springbov\"\u003e\n        \u003cimg\n          alt=\"springbov\"\n          src=\"https://raw.githubusercontent.com/simplyhexagonal/create-jscad-project/main/assets/contributors/springbov.svg\" width=\"117\"\n        /\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\n      \u003ca href=\"https://github.com/z3dev\"\u003e\n        \u003cimg\n          alt=\"z3dev\"\n          src=\"https://raw.githubusercontent.com/simplyhexagonal/create-jscad-project/main/assets/contributors/z3dev.svg\" width=\"117\"\n        /\u003e\n      \u003c/a\u003e\n    \u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## License\n\nThis project is licensed under the [Apache-2.0]([LICENSE](https://www.apache.org/licenses/LICENSE-2.0)).\n\nHappy Designing with `create-jscad-project`!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplyhexagonal%2Fcreate-jscad-project","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimplyhexagonal%2Fcreate-jscad-project","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimplyhexagonal%2Fcreate-jscad-project/lists"}