Skip to content

Commit da5d838

Browse files
2 parents ae2711d + 280462b commit da5d838

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
<div align="center">
22

3-
![React logo](assets/react.png "React logo")
4-
![Spring Boot logo](assets/springboot.png "Sprint boot logo")
3+
![React logo](assets/react.png "React logo")
4+
![Spring Boot logo](assets/springboot.png "Sprint boot logo")
55
</div>
66

7-
# Messenger project : real time chat with ReactJS and Spring Boot
7+
# Messenger project : real time chat with React and Spring Boot
88

9-
This web application is a project that I made myself to practice in Java and ReactJS. Please do not hesitate to contact me if you see any errors (small or big).
9+
Real time chat application group oriented. Talk with your friends, create and add users to conversation, send messages or images, set groups administrators and start video calls ! (coming soon)
10+
11+
## Next version preview :
12+
13+
Changelog for next version :
14+
15+
- Change project from javascript to typescript
16+
- Use of react Context instead of Redux for basic tasks (like theme)
17+
- Improve websocket reliability (one topic to subscribe instead of 5)
18+
- Fix bugs
19+
- Cookies to store theme preference
20+
21+
## Start-up :
1022

1123
#### Project Requirements
1224

@@ -18,16 +30,16 @@ This web application is a project that I made myself to practice in Java and Rea
1830

1931
- This project use [liquibase](https://www.liquibase.org/) as a version control for database. When you will start backend, all tables and structures will be generated automatically.
2032
- To try the project on localhost, check that nothing runs on ports 9090 (Spring Boot) and 3000 (React app)
21-
- You can edit ````spring.datasource```` in ```backend/src/main/resources/application.properties``` and ```username``` and ```password``` in ```backend/src/main/resources/liquibase.properties``` with your own SQL login / password
33+
- You can edit ````spring.datasource```` in ```backend/src/main/resources/application.properties``` and ```username``` and ```password``` in ```backend/src/main/resources/liquibase.properties``` with your own SQL login / password
2234
- Create a database named "websocket" or you can also modify the name in the properties files mentioned just above.
2335

2436
##### Start server
2537
- Go inside backend folder then type ```mvn spring-boot:run``` to launch backend.
26-
- Or you can type ```mvn clean package``` to generate a JAR file and then start server with ```java -jar path/to/jar/file``` (Normally in inside backend/target/)
38+
- Or you can type ```mvn clean package``` to generate a JAR file and then start server with ```java -jar path/to/jar/file``` (Normally in inside backend/target/)
2739
##### Start frontend
2840
- Go inside frontend-web folder and then type ```npm react-scripts start```
2941

30-
## Features
42+
# Project overview
3143

3244
![Project overview](assets/messenger.jpg?raw=true "Project overview")
3345

@@ -36,5 +48,5 @@ This web application is a project that I made myself to practice in Java and Rea
3648
* Secure user account based on Spring Security JWT
3749
* Room discussion with STOMP and SockJS
3850
* Chat group administrators
39-
* Add / remove users from conversation
51+
* Add / remove users from conversation
4052
* Dark / Light Mode

0 commit comments

Comments
 (0)