Seed code - Boilerplate for step 5 - Keep Note Project

Project Step Description

In this case study Keep Note Step 5, we will implement JWT (JSON Web Token) authentication on top of Keep Note Step 4 Assignment. JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed.

In this step, we will create this application in five parts

    1. AuthenticationService
    2. UserService
    3. NoteService
    4. CategoryService
    5. ReminderService

Filter using JWT should be implemented for all except the AuthenticationService.

Containerization of all the microservices using Docker needs to be implemented as part of this assignment. For each services, Dockerfile has to be updated with the required instructions. All the images to be run using the docker-compose.

Swagger needs to be implemented in all the services.

Steps to be followed:

Step 1: Clone the boilerplate in a specific folder on your local machine and import the same in your eclipse STS.
Step 2: Go thru the readme.md file and implement the code for AuthenticationService and run the test cases.
Step 3: Go thru the readme.md file and implement the code for UserService and run the test cases.
Step 4: Go thru the readme.md file and implement the code for NoteService  and run the test cases.
Step 5: Go thru the readme.md file and implement the code for CategoryService and run the test cases.
Step 6: Go thru the readme.md file and implement the code for ReminderService and run the test cases.

Project structure

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
|
├── AuthenticationService                   // This is the microservice for User Authentication
├── NoteService                             // This is the microservice of Note   
├── CategoryService                         // This is the microservice of Category   
├── ReminderService                         // This is the microservice of Reminder   
├── UserService                             // This is the microservice of User   
├── .gitignore			            // This file contains a list of file name that are supposed to be ignored by git 
├── .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. 
├── README.md			            // This is a readme file about the Keep Note step5 assignment. 
├── docker-compose.yml	                    // yml configuration file to define and run the multi-container docker application.
└── pom.xml 			            // This is the parent POM, which holds all the microservice projects.

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

To use this as a boilerplate for your new project, you can follow these steps

1. Clone the base boilerplate in the folder assignment-solution-step5 of your local machine

   git clone https://gitlab.stackroute.in/stack_java_keep_v2/KeepNote-Step5-Boilerplate.git assignment-solution-step5

2. Navigate to assignment-solution-step5 folder

   cd assignment-solution-step5

3. Remove its remote or original reference

   git remote rm origin

4. Create a new repo in gitlab named assignment-solution-step5 as private repo

5. Add your new repository reference as remote

   git remote add origin https://gitlab.stackroute.in/{{yourusername}}/assignment-solution-step5

   Note: {{yourusername}} should be replaced by your username from gitlab

6. Check the status of your repo

   git status

7. 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 .

8. 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

9. Check on the git repo online, if the files have been pushed