The goal of this project was to write a simple chat API using Spring Boot and authorizing requests with JWT Tokens. When a user joins they a certain abilities such as:
A user can:
- register
- login
- view their profile
- edit their profile
- create a chat
- edit a chat
- list all chats
- view all messages in a chat
- create a message in a chat
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
You only need to install a JVM (Preferably Java 8)
A step by step series of examples that tell you have to get a development env running
Say what the step will be
git clone https://github.com/ImperiousEnterprise/oraChatChallenge.git
And then run
mvn spring-boot:run
Once the application is running you can login with :
Admin user: [email protected]
123
Regular user: [email protected]
123
As for tests, I will need to upload tests later on. There are few edge cases I know I have missed.
This application can be deployed anywhere. (AWS, AZURE, your preference)
- Spring Boot - The web framework used
- Maven - Dependency Management
- [H2] - Embedded Database
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Git was used for versioning.
- Adefemi Adeyemi - Initial work - ImperiousEnterprise
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- Hat tip to anyone who's code was used
- Inspiration
- etc