Repository files navigation

This is a simple chat application that allows user to:

- [x] register- [X] login implements JWT- [x] view profile- [x] edit profile - [x] create a chat- [x] edit a chat- [x] edit profile/chat implements security(Only owner can edit)- [x] list all chats- [x] view all messages in a chat- [x] create a message in a chat- [x] logout

- Java- Spring Boot, Spring: Data JPA, Rest, Validator, MVC, ...- JUnit, Mockito- Maven- MySQL- Log4j2- JSON Web Token- Redis

What you will need:- JDK 1.8- Maven 3.5+- MySQL 5.7+- Redis

• You can change the database's connection and name in application.properties, you can find it inside resources directory
• Here I'm using root as my username and password, you can change according to your current configuration

• Install docker in your local machine

  • Mac user:https://docs.docker.com/desktop/install/mac-install/
  • Window user:https://docs.docker.com/desktop/install/windows-install/
  • Linux user:https://docs.docker.com/desktop/install/linux-install/

• Confirm your docker is up and running then run below command

  docker compose up

From the root of project directory (you will find pom.xml file there) run the following command

mvn clean installjava -jar target/simplechat-0.0.1.jar

You also use the following command

mvn spring-boot:run

Note: confirm your maven is pointing to correct java version, in our case it should be JDK 1.8, you can do so by running

mvn --version

The application will initialize some data from sample data set in import.sql in resource directory.

• Note: register and login request won't be filter with jwt. Other request required a valid token from successful login

curl --location --request POST 'http://localhost:8080/register' \ --header 'Content-Type: application/json' \ --data-raw '{ "username": "reg1234", "password": "1234", "firstName": "Jane", "lastName": "Dawn", "email": "test@gmail.com" }'

curl --location --request POST 'http://localhost:8080/login' \--header 'Content-Type: application/json' \--data-raw '{"username": "reg1234","password": "1234"}'

• Upon successful login it will return jwt token

curl --location --request GET 'http://localhost:8080/logout'

• It should return successfully logout message

• if you using different browser you have to include Cookie in your header with token

• eg: gettting list of users

  curl --location --request GET 'http://localhost:8080/api/users'
  --header 'Cookie: coco={{YOUR_AUTHENTICATED_TOKEN}}'

• YOUR_AUTHENTICATED_TOKEN this is generated cookies after loggin

• you need to successfully login first before access below API

• List of users.

  curl --location --request GET 'http://localhost:8080/api/users'

• return paginated list of users, with page number 0 as requested, you can change the number to see next page if available

  curl --location --request GET 'http://localhost:8080/api/users?page=0'

url:http://localhost:8080/api/users/1 (GET), 1 is user id

url:http://localhost:8080/api/users (PATCH), sample data

 {"id":"7","username": "uzer7","password": "1234","firstName": "Python Update","lastName": "Piper","email": "test@gmail.com"}

• url:http://localhost:8080/api/chats(GET)return paginated list of chat, with page number 0 as default

• url:http://localhost:8080/api/chats?page=0(GET)(DESC sort by posted date)return paginated list of chats, with page number 0 as requested, you can change the number to see next page if available

url:http://localhost:8080/api/chats (POST) , sample data

curl --location --request POST 'http://localhost:8080/api/chats' \--header 'Content-Type: application/json' \--data-raw '{"id":"5","owner": "1","message": "Hello Chat message number 5 by user 1","postedDate": "2024-10-04T22:44:30.652"}'

url:http://localhost:8080/api/chats/5 (GET), 5 is chat id

url:http://localhost:8080/api/chats (PATCH), Sample data

{"id":"1","owner": "1","message": "Update chat id 1 chat date","postedDate": "2016-10-04T22:44:30.652"}

• url:http://localhost:8080/api/messages(GET)return paginated list of messages, with page number 0 as default

• url:http://localhost:8080/api/messages?page=0(GET)(DESC sort by posted date)return paginated list of messages, with page number 0 as requested, you can change the number to see next page if available

url:http://localhost:8080/api/messages (POST) , sample data

curl --location --request POST 'http://localhost:8080/api/messages' \--header 'Content-Type: application/json' \--data-raw '{"id": "5","user": "1","chat": "1","message": "Hello Message reply to chat id 1","postedDate": "2024-05-04T22:44:30.652"}'

url:http://localhost:8080/api/messages/1 (GET), 1 is chat message id

url:http://localhost:8080/api/messages (PATCH), Sample data

{"id":"1","owner": "1","chat": "1","message": "Update message id 1 chat date","postedDate": "2016-11-04T22:44:30.652"}

The api path '/api/' can be change in application.properties file. You can find the file under resources directory

api.path: api

• Name : Khemroat Loem
• Email :khemroat@gmail.com