Skip to content

✨ Qflow: A seamless tool for visualizing, learning, and exploring programming concepts with a sleek UI and modern design. πŸš€ Perfect for developers and enthusiasts alike! πŸ’»

Notifications You must be signed in to change notification settings

annuk123/Qflows

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

17 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🌟 Qflow

An interactive tool to visualize and explore programming concepts with an elegant and modern user interface.

πŸš€ Overview

Qflow is a powerful and intuitive platform designed for developers, students, and enthusiasts to:

  • Visualize complex programming concepts in an easy-to-understand way.
  • Learn interactively with dynamic tools and guides.
  • Explore new technologies and understand their workflows visually.

Whether you’re a seasoned developer or a beginner, Qflow provides the perfect blend of simplicity and functionality to make learning and debugging enjoyable!


✨ Features

  • 🌐 Interactive Visualizers: Navigate through real-time event loops, state management, and database flows.
  • 🎨 Sleek Design: Minimalistic yet vibrant UI built with cutting-edge design frameworks.
  • πŸŒ— Dark/Light Mode: Choose your theme for a personalized experience.
  • πŸ”’ Secure Authentication: User-friendly login and sign-up system with OAuth support for Google and GitHub.
  • πŸ“š Docs & Guides: Built-in documentation for effortless onboarding.
  • πŸ› οΈ Built for Developers: Open-source and customizable for various use cases.

πŸ›  Tech Stack

Qflow is powered by a modern tech stack for scalability and performance:

  • Frontend: ReactJS, TypeScript, NextJS, TailwindCSS, Material-UI
  • Backend: NodeJS, ExpressJS, Prisma ORM
  • Database: NeonDB (PostgreSQL)
  • Authentication: Auth.js (OAuth 2.0)
  • UI Enhancements: Zod, GSAP, Three.js

🚧 Setup and Installation

Follow these steps to run Qflow locally:

1️⃣ Prerequisites

Ensure you have the following installed:

2️⃣ Clone the Repository

git clone https://github.com/annuk123/Qflows.git  
cd Qflows  

3️⃣ Install Dependencies

npm install  
# or  
yarn install  

4️⃣ Configure Environment Variables

Create a .env.local file in the root directory and add the following:

DATABASE_URL=<Your Database Connection URL>  
NEXTAUTH_URL=<Your App URL>
NEXTAUTH_SECRET=<Your Next Secret Key>
GOOGLE_CLIENT_ID=<Google OAuth Client ID>  
GOOGLE_CLIENT_SECRET=<Google OAuth Client Secret>  
GITHUB_CLIENT_ID=<GitHub OAuth Client ID>  
GITHUB_CLIENT_SECRET=<GitHub OAuth Client Secret>  

5️⃣ Start the Development Server

npm run dev  
# or  
yarn dev  

Your app will be running at http://localhost:3000.


🌐 Deploying to Vercel

You can deploy Qflow seamlessly on Vercel:

  1. Push your code to GitHub.
  2. Import the project into your Vercel dashboard.
  3. Add the environment variables in the Vercel settings.
  4. Deploy with one click!

πŸ“Έ Screenshots

πŸ’» Home Page

Home Page

🎨 Visualizers

Visualizer
Mobile view Mobile view

🀝 Contributing

Contributions are welcome! To get started:

  1. Fork this repository.
  2. Create a new branch: git checkout -b feature-xyz.
  3. Commit your changes: git commit -m "Add feature xyz".
  4. Push to the branch: git push origin feature-xyz.
  5. Open a pull request.

πŸ“œ License

This project is licensed under the MIT License.


πŸ™Œ Acknowledgments

A huge thanks to the open-source community and libraries that made this project possible!


Happy Coding! πŸ’»βœ¨

About

✨ Qflow: A seamless tool for visualizing, learning, and exploring programming concepts with a sleek UI and modern design. πŸš€ Perfect for developers and enthusiasts alike! πŸ’»

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages