Abhishek-Mallick / universal-box

Project scaffolding just got easier — streamline your development with Universal-Box's pre-built templates and one-click deployment! 🚀
https://universal-box.dev
Apache License 2.0
28 stars 26 forks source link

feat: added fullstack (vite+flask) template #131

Closed deepraj21 closed 1 month ago

deepraj21 commented 1 month ago

Description

Created a template for full stack (vite + flask) with signup and signin auth feature using mongodb database.

Fixes #130

How Has This Been Tested?

Manual testing

Checklist

Summary by CodeRabbit

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
universal-box ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 13, 2024 3:54am
coderabbitai[bot] commented 1 month ago

Walkthrough

The pull request introduces a full-stack project template utilizing Vite for the frontend and Flask for the backend, including MongoDB for data management. Key components include a new README file detailing setup instructions, various configuration files for Tailwind CSS and TypeScript, and multiple React components for user authentication and UI elements. The backend features user management with signup and signin functionalities, integrated with MongoDB. Additionally, .gitignore files are added to exclude unnecessary files from version control.

Changes

File Path Change Summary
.gitignore Added entries for bin/format/ and venv/.
template/FullStack/Vite(Frontend)+Flask(Backend)/README.md New file outlining installation and project structure for the full stack template.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/.gitignore New file specifying ignored files for the frontend.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/README.md New file detailing setup for React with TypeScript and Vite.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/components.json New configuration file for component settings.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/eslint.config.js New ESLint configuration for TypeScript and React.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/index.html New HTML entry point for the application.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/package.json New package.json defining project metadata and dependencies for the client.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/postcss.config.js New PostCSS configuration for Tailwind CSS integration.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/src/App.css New CSS file defining styles for the application.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/src/App.tsx New main App component utilizing routing and theming.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/src/components/Hero/Hero.tsx New Hero component with typewriter effect for a signup button.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/src/components/Theme/mode-toggle.tsx New component for toggling between light and dark themes.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/src/components/Theme/theme-provider.tsx New ThemeProvider component for managing application themes.
template/FullStack/Vite(Frontend)+Flask(Backend)/client/src/hooks/use-toast.ts New hook for managing toast notifications.
template/FullStack/Vite(Frontend)+Flask(Backend)/server/app.py New Flask application file with CORS and MongoDB integration.
template/FullStack/Vite(Frontend)+Flask(Backend)/server/models.py New file defining user management functions for MongoDB.
template/FullStack/Vite(Frontend)+Flask(Backend)/server/routes.py New routes for user signup and signin.
template/FullStack/Vite(Frontend)+Flask(Backend)/server/utils/Auth/auth.py New authentication handlers for signup and signin processes.

Assessment against linked issues

Objective Addressed Explanation
Create a template for full stack (vite + flask) with signup and signin auth feature using mongodb database. (#130)
Include necessary tech stacks: vite.js, typescript, python, flask, mongodb. (#130)
Provide a directory structure for the template. (#130)

Poem

🐰 In a world of code and light,
A template shines, oh what a sight!
With Vite and Flask, they dance and play,
Sign up, sign in, come join the fray!
MongoDB holds secrets tight,
In this rabbit's realm, all feels just right! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
deepraj21 commented 1 month ago

Changes done.

  1. Added .env.example with example secrets
  2. Added Oauth with Github and session using localstorage

Screenshot 2024-10-13 090828