Skip to content

Nox CLI – A simple and powerful CLI tool to jumpstart your web development projects. Automate page creation, set up Redux, and enjoy a modern boilerplate with React, TypeScript, Tailwind CSS, and more. Get your projects up and running in no time!

License

Notifications You must be signed in to change notification settings

pinak3748/Nox-CLI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Nox CLI – Web Dev, Simplified

Hey, you! Welcome to Nox, your new best friend in web development. Need a fast, modern setup for your web app? Nox has your back. Less time fiddling with boilerplates, more time doing what you love – writing glorious code!

🛠️ What’s Inside the Nox Boilerplate?

When you run Nox, it dishes out a feature-rich, modern boilerplate that’ll make your dev friends jealous:

  • React + TypeScript: Like peanut butter and jelly, but for your code.
  • Tailwind CSS: CSS, but like on rocket fuel (minus the rage quits).
  • Redux Toolkit: State management that won’t make you cry.
  • shadcn/ui: Makes other UI libraries look like they’re from the stone age.

Think of it like a five-course meal for your web app – React’s the entrée, TypeScript’s the safety net, Tailwind’s the flair, Redux keeps you sane, and shadcn/ui is the fancy garnish.

🍭 Bonus Features:

  • Style Guide Route: /style-guide — a one-stop shop for all your components.
  • Custom Components: Pre-made components so you can skip the boring bits.
  • Authentication Flow: Sign in, sign up, password reset... the whole shebang!

When you generate a new page with Nox, it sets up everything you need: Redux files, React components, and a nice modular structure. You get to jump right into the fun part!

🔥 Custom Components

Here’s what we’ve cooked up for you already:

  • signIn (/sign-in) — Because people need to log in, apparently.
  • signUp (/sign-up) — Let the onboarding fun begin.
  • forgotPassword (/forgot-password) — Oops, did you forget again?
  • resetPassword (/reset-password) — Reset. Restart. Repeat.
  • styleGuide (/style-guide) — Keep things looking sharp.
  • GPTPlayground (/gpt-playground) — AI magic, incoming.
  • timeLine (/time-line) — For those who need to visualize their life choices.

⚡ Features

  • Page Creation: One command, and boom, you’ve got a new page.
  • Redux Files: Automatically set up for you (because who likes manual setup?).
  • Modular Structure: Clean, organized, and ready to scale.
  • Consistency: Your file structure will be so neat, Marie Kondo would approve.

🚀 Getting Started

Install Nox (you’ve got Go installed, right?), and let’s get rolling:

go get -u github.com/yourusername/nox

🎛️ Nox Commands

The Big One:

  • nox — It’s the magic wand.
    • --page or -p: Creates a shiny new page for you.
    • --version or -v: Tells you what version of Nox you’re rocking.

💡 Future Ideas:

  • Dynamic component creation (because why stop at pages?).
  • Alias support (because who doesn’t love shortcuts?).
  • Specify output directories and templates.
  • Improved init command to set up project type, package manager, and more.

📦 Download the CLI

You can download the pre-built Nox CLI binaries from the binary/ folder. Choose the version that matches your operating system:

🖐️ Want to Contribute?

Join the party! It’s as easy as:

  1. Fork the project on GitHub.
  2. Create a branch for your genius idea.
  3. Push your changes.
  4. Send us a pull request, and we’ll high-five you virtually.

New to open source? No worries, we’re all just figuring it out as we go! 😄

🆘 Need Help?

If Nox is giving you trouble (or you just need a virtual hug), hit us up on GitHub. We’ve got your back!

About

Nox CLI – A simple and powerful CLI tool to jumpstart your web development projects. Automate page creation, set up Redux, and enjoy a modern boilerplate with React, TypeScript, Tailwind CSS, and more. Get your projects up and running in no time!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published