Mid Term Report For Internship
Mid Term Report For Internship
This report, in the form of a template, has been specifically designed for B.E (C.S.E) students
attending Industrial Training during 8th semester at respective Organizations/Industry/R&D
Institutes.
Note:
1. Use UK English
2. There should be NO grammatical or spelling mistakes
3. Submission after due date will not be accepted
4. For more information, contact TPC (CSE).
- Read the above carefully and attach this page at the end of your report before submission -
1. Project identification
1.4 Name of
Technical 1.4.1 Supervisor:
Supervisor(s)/ Name: Nikhil Jain
Manager(s) Designation: Chief Architect
(As officially assigned
at industry) 1.4.2 Supervisor (if any):
Name:
Designation:
1.5 CERTIFICATE
“This is to certify that the Industrial Training work until mid-year evaluation
held on ___________________, titled as stated in Sec. 1.3, executed (as till
date) by the student group mentioned in Sec. 1.1, has been found satisfactory (Signature of
and every section of this report is reflecting the same.” Supervisor &
date)
2. Project insights
Sub-areas (optional):
☐ Mobile Programming ☑ Web Programming ☐ HCI
☐ Data Mining ☐ Networking ☐ Image Processing
☐ Other (please specify):
2.2 Keywords
Headless Content Management System, Visual Editor,
(Max. 3 to 6. Don’t use Microfrontend, Unit and End-to-End Testing, Version Control
jargon or abbreviation) Systems
3.1 Undergrad.
courses Course code and title
5.
6.
3.
4.
5.
6.
3.3 Standards
Name, purpose, source and other details
and
databases MongoDB for non-relational data :
(Must be easily accessible. 1.
https://www.mongodb.com/
Add more rows if
required.)
2.
3.
4.
4.
4. Objective / Scope
Write the objective/scope that has been understood from project title and meetings with technical advisor(s) so far. Title and
scope of project must be elaborated in detail. Maximum 500 words.
Contentstack is a fully automated composable digital experience platform along with the
headless content management system. My team works on the visual experience for the
customers, and our current scope incorporates the projects such as Visual Editor, Timeline
API, Auth for Academy, etc.
I'm specifically working on Visual Editor. This tool lets you improve the live preview of a
website by using a visual editor. You can make changes easily either by filling out a quick
form or by directly editing the content in the website preview. It's like a magic window that
shows your website, and any changes you make happen right there in real-time.
Visual Editor is built with React and uses advanced web development concepts like lazy
loading, queries, and states to make it work smoothly. It's a snazzy way to make your website
look just the way you want it to!
5. Expected outputs
List expected outputs of the project in discrete terms. Maximum 250 words.
6. Utilization
Describe target beneficiaries, target market, potential customers, etc. Maximum 250 words.
This project is a helpful tool for people using Contentstack, especially those who like using
the live preview feature. It's designed to make things smoother between Contentstack's main
service (headless CMS) and the website builder.
This is useful for users because it improves how they work with Contentstack. The project is
meant for businesses and individuals who rely on Contentstack to manage their content.
People who create content, market things, and build websites can benefit from it. The tool
makes editing content easier and makes sure the headless CMS and website builder work
together seamlessly, making Contentstack more user-friendly for everyone.
The project is supposed to help retain our customers from competitors like Contenful and
Wordpress who provide the two services separately, that is headless cms and website builder,
which are both going to be available at Contentstack after the project goes live.
In the context of developing the Visual Editor project, the literature study focused on key
aspects of software engineering and web development. The following topics were explored to
define the project's path and methodology:
8. Methodology
Concisely list down the principle milestones and associated deliverables that must be achieved to accomplish the Training/project objectives. Add more rows if required.
Expected number
Percent
S. No. List of Training/Project milestones Deliverable(s) of days to
Completed
complete
1. EB-983: Visual Editor Bug Fixes ● Do unit and end to end testing, fixing bugs 120 70%
on the way.
● Get 100% coverage on the files that are
being gone through.
2. EB-987: Fix Over Fields ● Fix each field component rendering logic. 15 100%
● Make use of schema form components for
latest version.
3. ● Entry truncated values on rendering. 15 100%
EB-985: Truncate Entry
4. EB-940: Patch Event Data Load Repeat ● Patch event request from iframe for data 30 100%
load repeat.
5. EB-917: Core Editor ● Live preview sdk 150 20%
● Unit and E2E testing
● Graphql setup
● Rest setup
● Starter app integration (react, next, gatsby)
9. Executed work
Describe in detail the works along with the obtained results and deliverables that have been completed until now and how.
Note that very general information about topics is NOT required so try to be specific. The sequence, as already described in
Methodology (Sec. 8), should be followed as possible. Maximum 3 pages including equations, figures and tables etc.
Conducted comprehensive unit and end-to-end testing for the Visual Editor, addressing bugs
identified during the testing process.
Executed bug fixes in the source code, with a goal to achieve 100% test coverage for the
modified files, as specified in the project's testing scripts.
Monitored and improved test coverage metrics using tools like Jest, as specified in the
"coverage" script in the package.json.
Focused on fixing rendering logic issues associated with each field component within the
Visual Editor.
Incorporated the latest version of schema form components, as outlined in the project
dependencies ("dependencies" section in package.json), to ensure compatibility and leverage
the newest features.
Implemented a solution to truncate entry values during rendering in the Visual Editor, as
indicated in the task description.
Ensured that the implementation adheres to the project's dependencies, such as React ("react"
and "react-dom") and other related libraries specified in the package.json.
Addressed the issue of repeated data loading by patching event requests from the iframe, as
per the task description.
Focused on improving the efficiency of data loading processes by making adjustments to the
event handling logic.
Developed the Core Editor functionality within the Visual Editor, addressing the
requirements outlined in EB-917.
Integrated a Live Preview Software Development Kit (SDK) to enhance the live preview
experience for users.
Conducted both unit and end-to-end (E2E) testing to ensure the reliability and functionality
of the Core Editor.
Implemented GraphQL setup for efficient data querying and manipulation, as specified in the
project's dependencies ("graphql").
Set up a REST API, utilizing technologies outlined in the package.json ("axios") for seamless
communication between the Visual Editor and server.
Integrated the Core Editor with starter applications built using React, Next.js, and Gatsby,
aligning with the project's commitment to flexibility and compatibility.
Progress: 20% completion, indicating work in progress toward achieving the defined
milestones.
Currently addressing bugs through unit and end-to-end testing to achieve 100% coverage for
the modified files. Progress stands at 70%, with remaining work consisting of the rest of the
files that need to be tested.
Actively working on patching event requests from the iframe to prevent data load repeats.
Progress is at 40%, and most of the work here is taken in spike tickets as research is a
significant part of this.
Currently developing the Core Editor, integrating a Live Preview SDK, conducting unit and
end-to-end testing, setting up GraphQL and REST, and integrating with starter apps (React,
Next.js, Gatsby). Progress stands at 20%, with only Live Preview SDK having being
completed.
11.References
Style “IEEE - Reference Order” should be followed for giving references of books, research papers, reviews, online
resources, databases, software manuals, figures and anything else cited in this report.
[1] https://engineering.futureuniversity.com/BOOKS%20FOR%20IT/Software-
Engineering-9th-Edition-by-Ian-Sommerville.pdf
[2] https://www.amazon.in/Commercial-Application-Development-JavaScript-In
cluded/dp/8183330088
2. Project insights
3. Relevant study
material
4. Objective/Scope
5. Expected outputs
6. Utilization
7. Literature study/Data
collection
8. Methodology
9. Executed work
11. References
Overall performance