npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

create-jscad-project

v1.2.0

Published

An npm / npx starter template for JSCAD projects using Typescript and Hot Reload preview

Downloads

227

Readme

Create JSCAD Project

Introduction

An 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.

Demo GIF

Features

  • 🚀 Easy Setup: Initialize your JSCAD project with a single command.
  • 💻 TypeScript Support: Leverage the power of TypeScript for more robust code.
  • 🔁 Hot Reload Preview: Instantly view changes in your CAD design as you code.
  • 🔧 Automatic Interactive Controls: If you define parameters in your design, the viewport will render interactive controls that can be changed in the UI.
  • 📁 Automated Structure and Dependency Management: Automatically creates the necessary folder structure and installs dependencies.
  • 🎨 Focus on Design: Spend more time designing and less on setup.
  • 🛠️ Integrated VSCode Experience: Recommended extensions and launch configurations for a seamless development experience.
  • 📤 Advanced Export Options: Export your designs to X3D, 3MF, and SVG formats.

Like this project? ❤

Please consider:

Getting Started

Prerequisites

Ensure you have Node.js installed on your system to use npm or npx.

Installation

To create a new JSCAD project, run the following command in your terminal:

npm init jscad-project <your-project-name>

or

npx create-jscad-project <your-project-name>

This command will create a new directory with your project name, set up the folder structure, and install all the necessary dependencies.

Templates

To use a specific template, pass the --template argument when creating a new project. For example:

npm init jscad-project <your-project-name> -- --template=screw-and-nut

To list available templates you can run:

npx create-jscad-project --list-templates

There are currently two templates available:

  • default: A blank canvas for whatever project you're working on.
  • screw-and-nut: Contains a screw and nut for you to play with.

More templates will be added soon, hopefully by contributors too!

VSCode Integration

  • Recommended Extensions: The generated .vscode directory contains recommendations for helpful extensions. Please review and install them to enhance your development experience.
  • 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.
    • 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.

Alternatively - Development in other IDEs

If 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:

cd <your-project-name>
npm run dev

Preview and Export

  • In the preview window, you have the option to export your designs to X3D and 3MF file formats.
  • To export to SVG, project any parts into 2D and ensure the "Projection" checkbox is turned on.

Related Projects and Resources

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:

  • JSCAD: The core framework upon which this project is based. For more information and documentation, visit JSCAD's Github.

  • 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.

  • 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 for insights and inspiration.

Contributing

Contributions are welcome! Feel free to submit pull requests or open issues to improve create-jscad-project.

Contributors

License

This project is licensed under the Apache-2.0.

Happy Designing with create-jscad-project!