As a first step in building our Keep Note application, we will create a monolithic application.
A monolithic application is built as a single unit. Enterprise Applications are built in three parts:
- A database (consisting of many tables usually in a relational database management system),
- A client-side user interface (consisting of HTML pages and/or JavaScript running in a browser),
- A server-side application.
This server-side application will handle HTTP requests, execute some domain specific logic, retrieve and update data from the persistence storage, and populate the HTML views to be sent to the browser.
In this case study: Keep Note Step 1, we will develop a monolithic application which will get the note Id,title,content and status from the user using a form (JSP/HTML), persist the data in Array List and display all notes with details such as note id,note title, note content,note status and LocalDateTime of posting in a reverse chronological order (atest note first).
Note: For detailed clarity on the class files, kindly go thru the Project Structure
A form containing four text fields for Note ID, Note Title, Note Content, Note Status and a submit button, below to this will be a tabular column with the fields Note ID, Note Title, Note Content and LocalDateTime(This will be published in reverse chronological order). When the user enters the Note ID, Note Title, Note Content, Note Status and clicks on submit button, it gets stored in the array list and later render in tabular column.
- Display the list of notes from the array list. Each note should contain Note ID, Title, Content, Status and created date.
- Add a new note which should contain the Note ID, Title, Content and Status.
- Make sure to pass all the Unit test cases locally and on Hobbes.
Step 1: Clone the boilerplate in a specific folder in your local machine and import the same in your eclipse STS.
Step 2: Add relevant dependencies in pom.xml file.
Note: Read the comments mentioned in pom.xml file for identifying the relevant dependencies.
Step 3: In resources/beans.xml, add the required bean elements for Note model and NoteRepository class.
Step 4: Go through web.xml
Step 5: In dispatcher-servlet.xml, add base packages to scan and define the bean for view resolver.
Step 6: In Note.java file (which is considered as Model class), declare all the necessary variables for the model.
Step 7: In NoteRepository.java, create methods to add/retrieve/update/delete notes from the Array List.
Also Write a method which is used to retrieve all notes from array list.
Step 8: Run the test cases for NoteRepository(NoteRepositoryTest.java)
Step 9: In NoteController.java, get the application context from resources/beans.xml file using ClassPathXmlApplicationContext() class.Also get Note and NoteRepository objects from the application context.Annotate the NoteController.java with @Controller annotation.
Define a handler method to read the existing notes from the ArrayList, to read the Note data from requested parameters and save the new note in the Array List and delete a note.
Step 10: Run the testcases for NoteController (NoteControllerTest.java)
Step 11: Design a form with four text boxes (Note id, title, content and status) and a submit button and A table which shows Note id, title, content, status and the created date.
The folders and files you see in this repositories, is how it is expected to be in projects, which are submitted for automated evaluation by Hobbes
Project
|
├──src/main
| └─java
| └── com.stackroute.keepnote.controller
| └── NoteController.java // This class is used to control all the transactions with the persistence storage.
| └── com.stackroute.keepnote.model
| └── Note.java // The class will be acting as the data model for the Note data in the persistence storage.
| └── com.stackroute.keepnote.repository
| └── NoteRepository.java // This class contains the code for data interactions and methods of this class will be used by other
| parts of the applications such as Controllers and Test Cases
| └── resources
| └── beans.xml // This is a XML configuration file for bean objects definition
| └── webapp/WEB-INF
| └── dispatcher-servlet.xml // This is a XML configuration file required to define bean for View Resolver for the application
| └── web.xml // This is a XML configuration file required to configure the servlet an servlet-mapping elements
| └── webapp/WEB-INF/views
| └── index.jsp // A JSP page with a form and table in it, form will have textboxes for Note properties along with a Send Submit button.
| Table will contain fields namely Note id, title, content, status and created date which will render all the informantion from the persistence store.
|
├──src/test/java
└── com.stackroute.keepnote.test
| └── NoteRepositoryTest.java // All your test cases are written using JUnit, these test cases can be run by selecting Run As -> JUnit Test
| └── NoteControllerTest.java // This class contaions all the test cases related to Note Controller.
|
├── .settings
├── .classpath // This file is generated automatically while creating the project in eclipse
├── .hobbes // Hobbes specific config options, such as type of evaluation schema, type of tech stack etc., Have saved a default values for convenience
├── .project // This is automatically generated by eclipse, if this file is removed your eclipse will not recognize this as your eclipse project.
├── pom.xml // This is a default file generated by maven, if this file is removed your project will not get recognised in hobbes.
└── README.md // This files describes the problem of the assignment/project, you can provide as much as information and clarification you want about the project in this file
PS: All lint rule files are by default copied during the evaluation process, however if need to be customizing, you should copy from this repo and modify in your project repo
-
Clone the base boilerplate in the folder assignment-solution-step1 of your local machine
git clone https://gitlab-ibm.stackroute.in/stack_java_keep/KeepNote-Step1-Boilerplate.git -
Navigate to assignment-solution-step1 folder
cd assignment-solution-step1 -
Remove its remote or original reference
git remote rm origin -
Create a new repo in gitlab named
assignment-solution-step1as private repo -
Add your new repository reference as remote
git remote add origin https://gitlab-ibm.stackroute.in/{{yourusername}}/assignment-solution-step1.gitNote: {{yourusername}} should be replaced by your username from gitlab
-
Check the status of your repo
git status -
Use the following command to update the index using the current content found in the working tree, to prepare the content staged for the next commit.
git add . -
Commit and Push the project to git
git commit -a -m "Initial commit | or place your comments according to your need"git push -u origin master -
Check on the git repo online, if the files have been pushed
- We expect you to write the assignment on your own by following through the guidelines, learning plan, and the practice exercises
- The code must not be plagirized, the mentors will randomly pick the submissions and may ask you to explain the solution
- The code must be properly indented, code structure maintained as per the boilerplate and properly commented
- Follow through the problem statement shared with you
- You add the respective Mentor as a Reporter/Master into your Assignment Repository
- You have checked your Assignment on the Automated Evaluation Tool - Hobbes (Check for necessary steps in your Boilerplate - README.md file. ) and got the required score - Check with your mentor about the Score you must achieve before it is accepted for Manual Submission.
- Intimate your Mentor on Slack and/or Send an Email to [email protected] - with your Git URL - Once you done working and is ready for final submission.
*** Release 0.1.0 ***
- Right click on the Assignment select Run As -> Run on Server to run your Assignment.
- Right click on the Assignment select Run As -> JUnit Test to run your Assignment.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent