https://github.com/nitzanhen/agrippa

The CLI for frontend component generation
https://github.com/nitzanhen/agrippa

cli preact productivity react react-native solidjs

Last synced: 30 days ago
JSON representation

The CLI for frontend component generation

• Host: GitHub
• URL: https://github.com/nitzanhen/agrippa
• Owner: nitzanhen
• License: mit
• Created: 2021-07-30T14:38:47.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-11T17:05:41.000Z (over 1 year ago)
• Last Synced: 2024-10-01T04:04:11.183Z (about 1 month ago)
• Topics: cli, preact, productivity, react, react-native, solidjs
• Language: TypeScript
• Homepage: https://agrippa.dev
• Size: 837 KB
• Stars: 547
• Watchers: 10
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: Readme.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Agrippa


Agrippa is a CLI that helps frontend developers generate new components without the boilerplate: in a single command, it can create all the folders and files you need in a full component, with starting code tailored to your stack.



  


    

      Getting Started

         |   

      Documentation

    

  






## Quickstart

```bash

# 1. Install as dev dep

npm add -D agrippa

 

# 2. Create a config

npx agrippa init

# 3. Generate a component 🚀

npx agrippa gen my-first-component

```

For a complete introduction, take the short [Getting Started](https://www.agrippa.dev/getting-started/) tutorial! 


Alternatively, if you're already familiar with Agrippa, check out our [Set up Agrippa in a project](https://www.agrippa.dev/guides/setup-agrippa-in-a-project/) guide.




## See it in action

https://user-images.githubusercontent.com/58311807/188754758-1a5ea10b-6227-4c45-9976-bd115a8729c8.mp4




## Migrating from v1

Agrippa 2.0 introduces some API changes - the config is now a JS file and is structured a bit differently, and some options have been changed - but at large the functionality and usage is the same as v1.

To get a feel for the new version and see what's new, we recommend taking the new [Getting Started](https://www.agrippa.dev/getting-started/) tutorial, or the concise [Set up Agrippa in a project](https://www.agrippa.dev/guides/setup-agrippa-in-a-project/) guide.

Lastly, our new docs site, [agrippa.dev](https://www.agrippa.dev), contains reference pages regarding the options and config in v2, which you may find useful.

## Community

If you encounter any bugs or errors, or have any feature suggestions, please [open an issue](https://github.com/NitzanHen/agrippa/issues)!

Also, I'm not actively posting too much on Twitter, but I'd be more than happy to hear your toughts on Agrippa and discuss it with you! Find me [@nitzanhen](https://twitter.com/nitzanhen).

Lastly, thank you for being part of the community. 


If you like Agrippa and want to see it grow, please spread its word!