Skip to content

Abmarne/Nex

Repository files navigation

Nex

A modern, enterprise-grade Next.js application for business queue management.

Author: Abhiraj Marne

Local Setup and Testing

Follow these steps to set up the project locally:

  1. Clone the repository (if applicable):

    git clone <repository-url>
    cd <repository-directory>
  2. Install dependencies:

    npm install
    # or
    yarn install
    # or
    pnpm install
    # or
    bun install
  3. Environment Setup: Create a .env.local file in the root directory and ensure you add your Supabase connection strings (if needed):

    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
  4. Run the development server:

    npm run dev
    # or
    yarn dev
    # or
    pnpm dev
    # or
    bun dev
  5. Open the application: Open http://localhost:3000 with your browser to see the result.

Bypassing Login/Registration for Testing

If you need to test the application logic without setting up Supabase authentication or registering an account, you can quickly bypass the login/registration flow using one of these methods:

Method 1: Direct Navigation Since there isn't strict server-side middleware enforcing the route in development, you can directly navigate to the dashboard bypassing the auth forms by manually altering the URL:

http://localhost:3000/dashboard

Method 2: Force Authentication in Code You can alter the authentication form directly to immediately redirect to the dashboard without checking connection or credentials.

  1. Open src/components/auth/auth-form.tsx
  2. Locate the handleSubmit function.
  3. Replace the function logic to redirect directly:
    const handleSubmit = async (e: React.FormEvent) => {
      e.preventDefault();
      // Bypass auth logic and enter dashboard directly
      router.push("/dashboard");
    };
  4. Click the "Enter Command Center" button on the UI, and it will push you directly to the dashboard without waiting for remote validation.

(Make sure to revert this change before deploying to production!)

Learn More

To learn more about Next.js, take a look at the following resources:

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform. Check out the Next.js deployment documentation for more details.

Contributing

We welcome contributions to make Nex even better! Whether it's reporting a bug, suggesting a new feature, or submitting a pull request, your help is highly appreciated.

How to Contribute

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your feature, enhancement, or bug fix:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them with clear, descriptive messages:
    git commit -m "feat: add new feature description"
  4. Push your changes to your fork:
    git push origin feature/your-feature-name
  5. Open a Pull Request against the main branch of the original repository. Please provide a detailed description of your changes in the PR.

Coding Guidelines

  • Style: Maintain the modern, enterprise-grade design syntax already established in the project.
  • Code Quality: Ensure your code is clean, well-commented, and formatted consistently.
  • Testing: Test your changes thoroughly locally before submitting a PR.
  • Issues: If you plan on making major changes, please open an issue first to discuss your proposed changes with the maintainers.

About

A modern, real-time digital queue and waitlist management system built with Next.js and Supabase.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors