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!
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.
- 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!
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.
- 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.
Install Nox (you’ve got Go installed, right?), and let’s get rolling:
go get -u github.com/yourusername/nox
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.
- 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.
You can download the pre-built Nox CLI binaries from the binary/ folder. Choose the version that matches your operating system:
- Windows: nox_v0.1_windows_amd64.exe
- macOS (Intel): nox_v0.1_mac_amd64
- macOS (Apple Silicon): nox_v0.1_mac_arm64
Join the party! It’s as easy as:
- Fork the project on GitHub.
- Create a branch for your genius idea.
- Push your changes.
- 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! 😄
If Nox is giving you trouble (or you just need a virtual hug), hit us up on GitHub. We’ve got your back!