diff --git a/README.md b/README.md index 60888d8..1c6be73 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,30 @@ -# vue-mailServer +# Email Application -This template should help get you started developing with Vue 3 in Vite. +A modern web-based email application that allows users to send, receive, and manage their email messages with a clean and user-friendly interface. Built with Spring Boot for the backend and Vue.js for the frontend, this application provides robust email functionality with a focus on performance and scalability. -## Recommended IDE Setup +## Overview -[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin). +The Email Application offers a comprehensive suite of features for managing email communications. Users can compose, send, and organize emails, as well as manage their inbox, sent items, and drafts. The application includes a responsive interface, search functionality, and supports multiple email accounts. -## Customize configuration +## Features +- **User Management**: + - **Account Registration & Login**: Secure user authentication and account management. -See [Vite Configuration Reference](https://vitejs.dev/config/). +- **Email Management**: + - **Compose & Send Emails**: Create and send new emails with attachments. + - **Inbox Management**: Receive and organize incoming emails. + - **Sent Items**: View and manage sent emails. + - **Drafts**: Save and edit email drafts. -## Project Setup +- **Search and Filtering**: + - **Search**: Quickly find emails using keywords, sender, subject, and date. + - **Filter**: Sort emails by various criteria such as date, sender, and priority. -```sh -npm install -``` +## Technologies Used -### Compile and Hot-Reload for Development +- **Frontend**: + - **Vue.js**: A progressive JavaScript framework for building interactive user interfaces. + - **Bootstrap**: For responsive design and improved user experience. -```sh -npm run dev -``` - -### Compile and Minify for Production -```sh -npm run build -``` - - -https://github.com/WorldisAmen/Email-Server/assets/145727573/44569f10-ae06-42f7-8b64-82245f7db659 +- **Backend**: + - **Spring Boot**: A powerful framework for creating and managing backend services.