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 + Express - FullStack #96 #123

Closed protob closed 1 month ago

protob commented 1 month ago

Description

Add fullstack template: Vue.js with Express.js. Fixes issue #96

Type of Change

How Has This Been Tested?

The code has been tested manually:

cd client && npm install && npm run dev
cd server && npm install && npm run dev

Checklist

Additional Notes

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

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 8, 2024 5:41pm
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes introduce a comprehensive FullStack template utilizing Vue.js for the frontend and Express.js for the backend. Key components include user authentication, session management with JWT, and a responsive UI styled with Tailwind CSS. The README file provides detailed installation instructions, API routes, and frontend navigation. New environment variables are defined, and multiple Vue components are created for various functionalities, including user sign-up, sign-in, and account management. The backend includes controllers, routes, and middleware for handling authentication and user data.

Changes

File Path Change Summary
template/FullStack/Vue(Frontend)+Express(Backend)/README.md Added comprehensive README outlining project purpose, features, installation instructions, and API routes.
template/FullStack/Vue(Frontend)+Express(Backend)/client/.env.example Added environment variables: VITE_BASE_URL, MONGO_URL, JWT_SECRET, PORT.
template/FullStack/Vue(Frontend)+Express(Backend)/client/index.html Introduced main entry HTML file for the Vue application.
template/FullStack/Vue(Frontend)+Express(Backend)/client/package.json Created package.json for Vue frontend, defining project metadata, scripts, and dependencies.
template/FullStack/Vue(Frontend)+Express(Backend)/client/postcss.config.js Added configuration for PostCSS with Tailwind CSS and Autoprefixer.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/App.vue Added main application layout component with header, footer, and router view.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/api.js Introduced Axios instance for API requests with error handling.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/components/Cards.vue Added component for displaying project cards with dynamic data.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/components/CardsListingHover.vue Created component for item display with hover effects.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/components/Footer.vue Added footer component with copyright notice.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/components/Header.vue Introduced header component with navigation based on authentication state.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/composables/useForm.js Created composable for managing form state and validation.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/index.css Integrated Tailwind CSS framework into the styling.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/main.js Set up Vue application instance with routing and state management.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/router/index.js Added Vue Router configuration with authentication guards.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/stores/auth.js Introduced Pinia store for managing authentication state.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/views/Account.vue Created account management view with user info and sign-out functionality.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/views/Home.vue Added home view component with welcome message and project cards.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/views/Signin.vue Introduced sign-in component with form handling and validation.
template/FullStack/Vue(Frontend)+Express(Backend)/client/src/views/Signup.vue Created sign-up component with form handling and validation.
template/FullStack/Vue(Frontend)+Express(Backend)/client/tailwind.config.js Added Tailwind CSS configuration file.
template/FullStack/Vue(Frontend)+Express(Backend)/client/vite.config.js Introduced Vite configuration file for project setup.
template/FullStack/Vue(Frontend)+Express(Backend)/server/.env.example Created environment configuration file for backend with MONGO_URL, JWT_SECRET, and PORT.
template/FullStack/Vue(Frontend)+Express(Backend)/server/controllers/auth.controller.js Added authentication controller with signup and signin functions.
template/FullStack/Vue(Frontend)+Express(Backend)/server/controllers/user.controller.js Introduced user controller with functions for user management.
template/FullStack/Vue(Frontend)+Express(Backend)/server/index.js Set up entry point for Express backend, including middleware and route definitions.
template/FullStack/Vue(Frontend)+Express(Backend)/server/middleware/auth.middleware.js Added middleware for JWT verification.
template/FullStack/Vue(Frontend)+Express(Backend)/server/models/user.js Defined Mongoose schema for User model.
template/FullStack/Vue(Frontend)+Express(Backend)/server/package.json Created package.json for Express backend with dependencies and scripts.
template/FullStack/Vue(Frontend)+Express(Backend)/server/routes/auth.route.js Added routes for user authentication.
template/FullStack/Vue(Frontend)+Express(Backend)/server/routes/user.route.js Introduced user-related routes with middleware for profile access.
template/FullStack/Vue(Frontend)+Express(Backend)/server/utils/error.js Created error handling utility function.
website/content/Templates/FullStack/2.Vue(Frontend)+Express(Backend).md Added documentation for the FullStack template.

Possibly related issues

🐰 In a garden full of code,
A template blooms, a new abode.
With Vue and Express hand in hand,
A full-stack dream, so well planned!
From sign-ups to logs, all in a row,
Hop along, let the features flow! 🌼

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.