search

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:[TEMPLATE] - Vue + Django - FullStack #97 #139

Closed protob closed 1 month ago

protob commented 1 month ago

Description

Fullstack template using Vue + Django Fixes issue #97

Type of Change

How Has This Been Tested?

The code has been tested manually

Checklist

Additional Notes

Add any other context or information that may be helpful for the reviewers.

Summary by CodeRabbit

Release Notes

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 9:10pm
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request introduce a comprehensive FullStack template that integrates Vue.js for the frontend and Django for the backend. Key components include a detailed README file outlining the project's purpose, features, technologies, and installation instructions. Additionally, new files for environment configurations, Vue components, and Django API views are created, facilitating user authentication and interaction. The backend is structured to handle user management with JWT authentication and includes necessary configurations for development.

Changes

File Change Summary
template/FullStack/Vue(Frontend)+Django(Backend)/README.md Added comprehensive README outlining project features, technologies, installation instructions, and API routes.
template/FullStack/Vue(Frontend)+Django(Backend)/client/.env.example Introduced VITE_BASE_URL environment variable for base URL configuration.
template/FullStack/Vue(Frontend)+Django(Backend)/client/index.html Created entry point HTML file for the Vue.js application.
template/FullStack/Vue(Frontend)+Django(Backend)/client/package.json Added new package.json for Vue.js frontend specifying dependencies and scripts.
template/FullStack/Vue(Frontend)+Django(Backend)/client/postcss.config.js Created PostCSS configuration file with Tailwind CSS and Autoprefixer plugins.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/App.vue Introduced main application layout component.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/api.js Set up Axios instance for API requests with error handling.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/components/Cards.vue Created component for displaying project cards.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/components/CardsListingHover.vue Added component for grid display with hover effects.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/components/Footer.vue Created footer component with copyright notice.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/components/Header.vue Introduced navigation header component with authentication links.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/composables/useForm.js Created composable for form state management and validation.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/index.css Integrated Tailwind CSS into the project.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/main.js Established entry point for Vue application setup and plugin integration.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/router/index.js Configured Vue Router with authentication guards.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/stores/auth.js Created Pinia store for managing authentication state.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/views/Account.vue Added account view component for user details and sign-out.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/views/Home.vue Created home view component with welcome message and project cards.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/views/Signin.vue Developed sign-in component with form validation.
template/FullStack/Vue(Frontend)+Django(Backend)/client/src/views/Signup.vue Created sign-up component with user registration form.
template/FullStack/Vue(Frontend)+Django(Backend)/client/tailwind.config.js Added Tailwind CSS configuration file.
template/FullStack/Vue(Frontend)+Django(Backend)/client/vite.config.js Configured Vite for Vue.js application with PostCSS support.
template/FullStack/Vue(Frontend)+Django(Backend)/server/.env.example Introduced environment variables for the Django backend configuration.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/__init__.py Created package initializer for the API module.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/admin.py Registered custom User model with Django admin.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/apps.py Added application configuration for the API app.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/migrations/__init__.py Created initializer for migrations package.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/models/__init__.py Imported User class for accessibility in the API module.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/models/user.py Introduced custom user model and manager for authentication.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/serializers.py Created serializer for the User model.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/services/auth_service.py Implemented authentication service for user login/logout and JWT handling.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/services/user_service.py Added user service for profile retrieval.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/urls.py Established URL routing for authentication and user profile APIs.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/utils/__init__.py Created initializer for utilities package.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/utils/error.py Added standardized error response function.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/views/__init__.py Imported view classes for user authentication.
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/views/auth_view.py Implemented API views for user authentication (signup, signin, signout).
template/FullStack/Vue(Frontend)+Django(Backend)/server/api/views/user_view.py Added views for user profile and test endpoint.
template/FullStack/Vue(Frontend)+Django(Backend)/server/config/asgi.py Configured ASGI application for Django backend.
template/FullStack/Vue(Frontend)+Django(Backend)/server/config/settings.py Established Django settings with environment variables and configurations.
template/FullStack/Vue(Frontend)+Django(Backend)/server/config/urls.py Set up URL routing for admin and API endpoints.
template/FullStack/Vue(Frontend)+Django(Backend)/server/config/wsgi.py Configured WSGI application for Django backend.
template/FullStack/Vue(Frontend)+Django(Backend)/server/manage.py Created management script for Django application.
template/FullStack/Vue(Frontend)+Django(Backend)/server/requirements.txt Updated dependencies for Django backend.
template/FullStack/Vue(Frontend)+Django(Backend)/server/setup.sh Added setup script for automating environment setup.
template/FullStack/Vue(Frontend)+Django(Backend)/server/shell.nix Introduced Nix shell configuration for development environment.
website/content/Templates/FullStack/2.Vue(Frontend)+Django(Backend).md Created starter template documentation for Vue.js and Django integration.

Possibly related issues

🐰 In the garden of code we play,
🌱 A template blooms, bright as day.
🌼 Vue and Django, hand in hand,
🌍 Creating apps that are simply grand!
🎉 With every line, a joy to see,
🐇 Hopping forward, come code with me!

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.
protob commented 1 month ago

@Abhishek-Mallick, thanks for merge and invitation.