Giter VIP home page Giter VIP logo

minidocs-e6156-document-service's Introduction

MiniDocs Project Readme

Overview

MiniDocs is a cloud-native application designed to facilitate document management. Developed by the E6156 - Topics in SW Engineering Management: Cloud Computing team at Columbia University, this project offers an efficient and user-friendly way to manage documents in the cloud.

Project Links

Physical View

Key Features

MiniDocs allows users to:

  • Login using their Columbia/Google email address.
  • Perform Create, Read, Update, Delete (CRUD) operations on documents they own.
  • Share documents with other users via email.
  • Receive email notifications for updates or shares.

Document Features

  • CRUD operations.
  • Grammar checks via an External Grammar API microservice.

Notification System

  • Amazon SNS triggers emails for file updates or shares.

User Roles

  • Owner: Manages their own files.
  • Viewer: Accesses files shared with them.

Technical Architecture

Services

  1. Document Service (Container):

    • Manages document creation, editing, storage, content, and permissions.
  2. User Authentication and Authorization Service (Google Cloud):

    • Handles user authentication, authorization, and access control.
  3. Document Utility Service (EC2):

    • API utility service for grammar checks on document text.
  4. Notification System (EC2):

    • Email notifications via SNS topics and Lambda functions.
  5. GraphQL:

    • Basic GraphQL application for querying user data.

Resource Paths

  • /api/docs: OpenAPI documentation.
  • /files: Document management.
  • /auth: User authentication.
  • /users: User management.
  • /grammarcheck: Grammar check service.
  • /share: Document sharing.

Agile Project

  • Managed using Agile methodologies.

Codebase

Links to Deployment

Conclusion

MiniDocs represents a comprehensive solution for cloud-based document management, emphasizing ease of use, security, and efficient document handling. This project is a testament to the collaborative effort and technical expertise of the E6156 team.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.