From bddd0bf996fdd92bdb9d807c574cfb8278055d4c Mon Sep 17 00:00:00 2001 From: Mohammad Shahid Beigh <85876937+MohammadShahidBeigh@users.noreply.github.com> Date: Mon, 21 Oct 2024 13:47:13 +0530 Subject: [PATCH] Readme.md --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 83e53b1..2e2111e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -# Research Paper Management System +# MindVault ## Overview -This Research Paper Management System is a web application designed to help researchers and academics organize, manage, and collaborate on research papers. It provides a user-friendly interface for uploading, categorizing, and searching research papers, as well as tools for collaboration and analysis. +MindVault is a web application designed to help researchers and academics organize, manage, and collaborate on research papers and other academic resources. It provides a user-friendly interface for uploading, categorizing, and searching research papers, as well as tools for collaboration and analysis. ## Features - User authentication and authorization -- Upload and manage research papers -- Categorize papers with tags and metadata +- Upload and manage research papers and personal notes +- Categorize content with tags and metadata - Advanced search functionality -- Collaboration tools for sharing and commenting on papers +- Collaboration tools for sharing and commenting on content - Data visualization for research trends and metrics - Responsive design for desktop and mobile use @@ -24,6 +24,11 @@ This Research Paper Management System is a web application designed to help rese - UI Framework: Material-UI - GraphQL for efficient data querying - XSS protection for enhanced security +- Containerization: Docker +- Deployment: AWS EC2 + - GraphQL Endpoint: [http://43.205.10.7:4000/graphql](http://43.205.10.7:4000/graphql) + - Application Endpoint: [http://43.205.10.7:3000/](http://43.205.10.7:3000/) +- CI/CD: GitHub Actions ## Getting Started @@ -34,7 +39,7 @@ This Research Paper Management System is a web application designed to help rese ## Contributing -We welcome contributions to improve the Research Paper Management System. Please read our contributing guidelines before submitting pull requests. +We welcome contributions to improve MindVault. Please read our contributing guidelines before submitting pull requests. ## License