Archetyper

Setup your project files and directory structure in one command!

This project is still in alpha stage and under active development. Released features should work with no issues.

Features

• Cross platform. Should work on any platform that can run NodeJS
• Intuitive one line command for generating project files and directories
• No requirement for package install. Can be run with NPX directly
• JSON based config for the structure and file content template

Getting Started

The required files and directories can be generated by using the following command:

npx archetyper <option> <project name> <config/s>

Example:

A simple node JS project with the starting point index.js, .env file and parsing and package.json files can be generated using:

npx archetyper create sample-project nodeJs dotenv

Docs and Contribution guidelines

Developer and user docs coming soon!

Wish to contribute? We are in the process of framing our contribution guidelines, but until then, please note these points before raising a PR:

• Create an issue and discuss before starting on the feature/fix
• Ensure the code works!
• Follow good variable naming and coding conventions
• Try to keep the diff minimal

License

MIT

Maintainers

Team behind maintaining this project:

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!