creature-shoveler

Some thing
See live (soon) »

Report Bug :: Request Feature

OK, DOkey

Table of Contents

1. About
   • Built With
2. Getting Started
   • Prerequisites
   • Repo
   • Develop
   • Build
   • Deploy
3. Roadmap
4. Contributing
5. License
6. Acknowledgments

---

TL;DR - skip to getting-started

---

About

Yet another flying shoveler

creature-shoveler is a project automation tool designed to streamline the initialising projects. It empowers developers by automating the setup of project structures, reducing (some of the) manual configuration time, and ensuring consistent README.md layouts.

Why creature-shoveler?

Copier is written in Python. Yeoman and other nodejs generators are either dead projects or too overkill, or/and inflexible.

Contributing

Contributions to creature-shoveler are welcome! Fork the repository, create your feature branch, commit your changes, and submit a pull request. Please refer to the Contributing Guidelines for more details.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Features

• Template-based Project Creation: Quickly generate project structures tailored to Node.js, Go, Rust, and Python, including Dockerfile configurations and README templates.

• Customizable Templates: Utilize customizable templates for various project aspects such as README files, Dockerfile, package descriptors, configurations, and more.

• Prompt-based Configuration: User-friendly prompts guide users through project setup, allowing customization of project names, descriptions, licenses, and other boring yet important matters.

Of course, nothing is perfect, but I will try to keep this up to date and fix issues right here. If you've truly tried everything and still can't get this to work for you, try to reach out. Or raise an issue. But I make no promise

(back to top)

Built With

• node.js - of course
• typescript

Also using

• winston
• enquirer

---

Getting Started

Prerequisites

• you need Git installed
• and nodejs of course

Set up repo

$ git clone https://github.com/apply-creatures/creature-shoveler.git

Navigate to the repo root's folder & install dependencies

$ cd ./creature-shoveler && npm install

Develop

$ npm run start

Access via browser

• Hit http://localhost:3000

run tests

$ npm run test

Build

This command will compile for production deployment:

$ npm run build

Deploy

$ npm run deploy

(back to top)

---

Roadmap

• Setup a repo with nodejs
• Write the core logic
• Templates for nodejs
• Some Test
• Templates for Python
• Templates for other common tech

---

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/some-feature)
3. Commit your Changes (git commit -m 'Add some feature')
4. Push to the Branch (git push origin feature/some-feature)
5. Open a Pull Request

For more on how to contribute and the code of conduct, see CONTRIBUTING.md.

Security

To report vulnerabilities, see SECURITY.md.

---

(back to top)

---

Acknowledgments

It would never end. I've done this work not just off dozens of other people's open source work, but hundreds, thousands, or maybe millions.

Changelog

Changelog see here

License

If you too produce work and publish it out there, it's clearer to choose a license.