https://github.com/vinayakkulkarni/janak

Your next vue.js package!
https://github.com/vinayakkulkarni/janak

saojs scaffold-template scaffolding template vue vue-composition-api vue2 vue3

Last synced: 4 months ago
JSON representation

Your next vue.js package!

• Host: GitHub
• URL: https://github.com/vinayakkulkarni/janak
• Owner: vinayakkulkarni
• License: mit
• Created: 2020-05-10T07:34:47.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-25T02:53:17.000Z (over 1 year ago)
• Last Synced: 2025-04-13T02:44:40.790Z (8 months ago)
• Topics: saojs, scaffold-template, scaffolding, template, vue, vue-composition-api, vue2, vue3
• Language: JavaScript
• Size: 10.2 MB
• Stars: 29
• Watchers: 2
• Forks: 3
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-vue - janak - Your next vue.js package! ` 📝 2 months ago ` (Scaffold [🔝](#readme))
• awesome-vue - janak - Build your Vue 3 apps in a breeze 🌬 (Components & Libraries / Scaffold)

README

          


  



[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vinayakkulkarni/janak/ci.yml?logo=github-actions)](https://github.com/vinayakkulkarni/janak/actions/workflows/ci.yml)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vinayakkulkarni/janak/codeql.yml?logo=lgtm&logoWidth=18)](https://github.com/vinayakkulkarni/janak/actions/workflows/codeql.yml)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/vinayakkulkarni/janak/shipjs-trigger.yml?label=⛴%20Ship.js%20trigger)](https://github.com/vinayakkulkarni/janak/actions/workflows/shipjs-trigger.yml)

[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/vinayakkulkarni/janak?sort=semver&logo=github)](https://github.com/vinayakkulkarni/janak/releases)

[![GitHub Release Date](https://img.shields.io/github/release-date/vinayakkulkarni/janak)](https://github.com/vinayakkulkarni/janak/releases)

[![npm](https://img.shields.io/npm/dm/janak)](https://www.npmjs.com/package/janak)

[![npm](https://img.shields.io/npm/dt/janak)](https://www.npmjs.com/package/janak)

[![GitHub issues](https://img.shields.io/github/issues/vinayakkulkarni/janak)](https://github.com/vinayakkulkarni/janak/issues)

[![GitHub last commit](https://img.shields.io/github/last-commit/vinayakkulkarni/janak)](https://github.com/vinayakkulkarni/janak/commits/master)

![Maintenance](https://img.shields.io/maintenance/yes/2023)

[![GitHub contributors](https://img.shields.io/github/contributors/vinayakkulkarni/janak)](https://github.com/vinayakkulkarni/janak/graphs/contributors)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fjanak.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fjanak?ref=badge_shield)

> Quickly scaffold a new Vue 2.x package (with [@vue/composition-api](https://vue-composition-api-rfc.netlify.app/#api-introduction)) without all the headache of setting it up from scratch

Preview

![preview](./assets/janak.gif)

## Usage

```bash

npx janak 

```

## Features

- _🎉[Composition API](template/base/_package.json#L34) baked in_

- _👨‍🔧[TypeScript](template/base/src/Package.vue#L7) support_

- _🎢Build everything using [Rollup](template/base/build/rollup.config.js)_

- _🏗Trigger publishing on npm registry using [ship.js](https://community.algolia.com/shipjs/guide/getting-started.html)_

- _🧪Ava 3.x for testing_

- _🥳[Prettier](template/base/.prettierrc) & [ESLint](template/base/.eslintrc.js) give you powerful linting_

- _👀[jsconfig](template/base/jsconfig.json) for that dope `@/` importing power_

- _🦮[Husky](template/base/husky.config.js) & [Commitlint](template/base/commitlint.config.js)_

- _🤖GitHub Actions [CI](template/base/.github/workflows/shipjs-trigger.yml) for auto-publishing_

- _🤖[Dependabot](template/base/.github/dependabot.yml) for keeping packages upto date_

- _📖[VuePress](https://vuepress.vuejs.org/) for writing those amazing docs!_

- _👨🏻‍💻[Netlify](https://app.netlify.com/) for auto-publishing those amazingly written docs!_

## Notes

- [Janak](https://translate.google.com/#view=home&op=translate&sl=auto&tl=hi&text=Generator) (in Hindi) roughly translates to a generator, hence the name.

- Special thanks to [egoist](https://github.com/egoist), [znck](https://github.com/znck)

## License

MIT © [Vinayak](https://vinayakkulkarni.dev)

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fjanak.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fjanak?ref=badge_large)