🚧 Under construction - features may change at fast pace

Something: Starter Template

Welcome to the Something Starter Template—your launchpad for building modern web applications that are not just functional but extraordinary! Whether you're a seasoned developer or just starting your coding journey, this template has everything you need to create stunning, production-ready apps easily.

🌟 Why Choose Something?

Imagine a world where authentication is seamless, your code is clean, and your applications scale like a dream. With Something, that world is your reality! Packed with powerful features, this template makes your development process smooth.

🔑 Advanced Authentication

Security shouldn’t be an afterthought—it should be baked in.

• Multi-Factor Authentication: Keep your users safe with MFA, including authenticator apps, OTPs, and backup codes.
• Password Management: Password resets and changes made easy and secure.
• Anomalous Login Detection: Automatically spot suspicious activity before it becomes problematic.
• Email Notifications: Keep your users informed with email notifications for account changes.

Event-Driven Architecture

Embrace the future with a design that scales effortlessly.

• Using Mitt: Employ the Pub/Sub pattern for dynamic event handling—let your app react to the world!

Modular Repositories

Clean, maintainable code is the dream.

• Server-Side Rendering(SSR): Improve SEO and user experience with SSR for your frontend.
• Bulletproof Structure: Organize your code into modular repositories, making it easy to manage and expand.
• Shared Codebase: Share code between the frontend and backend, ensuring consistency and reducing duplication.

Next, Vite & Node.js

Say goodbye to long build times!

• Lightning-Fast Development: Experience the speed of Vite paired with a robust Node.js backend.

MongoDB & Mongoose

Your data, your way.

• Flexible Modeling: Create the database structure that fits your needs with Mongoose.

Comprehensive Testing

Your code deserves the best.

• Jest Testing Suite: Write and run tests for both the backend and frontend, ensuring your app runs smoothly and as expected.

Role-Based Access Control

Power and flexibility in user management.

• Fine-Grained Permissions: Control who can do what with an easy-to-use role-based system.

Storybook for UI Components

Test your components in isolation.

• Design Confidence: Document and showcase your UI elements, ensuring they work perfectly before they hit the stage.

Full TypeScript Support

Type safety is your best friend.

• Code with Confidence: Write cleaner, more reliable code with full TypeScript support.

Linting & Formatting

A consistent style for a polished product.

• ESLint & Prettier: Keep your code looking sharp and professional.

🚀 Getting Started

Ready to embark on your development journey? Here’s how to get started:

Prerequisites

• Node.js (version 16+)
• MongoDB
• npm

Installation Steps

1. Use the template by clicking on the Github-provided button

2. Clone your repository

   git clone https://github.com/<your-username>/<your-repo-name>

3. Initialise the project

   npm run init

4. Run the app in development mode or production mode

   # Development mode
   npm run dev:server
   npm run dev:vite # for Vite
   npm run dev:next # for Next.js
   
   # Production mode
   npm run build:server
   npm run build:vite # for Vite
   npm run build:next # for Next.js

5. Open your browser and navigate to http://localhost:6969 to see your app in action!

🤝 Contributing

We’d love to see your contributions! Check out our Contributing Guidelines for ways to get involved.

License

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

---

So what are you waiting for? Dive in, build something amazing, and let your creativity shine! ✨

© 2024 Something. All rights reserved.