abhishekpatel946/innoscripta-backend

Email Engine

Prerequisites

• Create a google-application and get the credentials associated with the application & pass the credentials into the docker-compose file.

 - CLIENT_ID=
 - CLIENT_SECRET=

• You need to install the docker & docker-compose in your system

Run

• To run the application start docker-compose with the following command

docker-compose up

Folder Structure

1. Client Application

├── Dockerfile                          - Dockerize the front-end application
├── package-lock.json
├── package.json                        - Package dependencies & configuration
├── public
│   ├── images                          - Public assets
│   │   ├── google.png
│   │   ├── login.jpg
│   │   ├── profile.jpg
│   │   └── signup.jpg
│   └── index.html
└── src                                 - Client application files
    ├── App.css
    ├── App.js                          - Main `App.js` file containing the routing logic
    ├── index.css
    ├── index.js                        - React `index.js` file containing the wrappers
    └── pages
        ├── Home                        - Home page after login
        │   ├── index.jsx
        │   └── styles.module.css
        ├── Login                       - Login page
        │   ├── index.jsx
        │   └── styles.module.css
        └── Signup                      - Signup page
            ├── index.jsx
            └── styles.module.css

2. Server NodeJS Application

├── Dockerfile                          - Dockerfile the back-end application
├── elasticsearch
│   └── index.js                        - ElasticSearch client & queries
├── package-lock.json
├── package.json                        - Package dependencies & configurations
├── passport.js                         - Authentication through passport
├── routes
│   ├── auth.js                         - Contains all the authentication & callback endpoints
│   └── email.js                        - Contains all the email endpoints (IMAP & ES Queries)
└── server.js                           - Main `server.js`

Components

1. Client: React application to interact with the backend and database

• Login mechanism with oauth implementation
• List of user details

2. Server: NodeJS server mainly managed the oauth & elasticsearch db operations

• Oauth implementation for google as of now only
• Elasticsearch implementation
• IMAP implementation (not implemented yet)

The below functionalities not implemented yet due to time restrictions. These below pointers are enhancement and missing functionality from existing systems

What we can do more

• Complete the entire the functionality using IMAP or APIs for email engine.
• Implement a kind of factory-design interface to support the google-cloud & microsoft and other services.
• Implement the redux state management in client side to prevent unnecessary calls to backend and store all data at client side.
• Implement the search, query and update functionality with Elasticsearch.