tutoring-platform

Table of contents

• About The Project
• Technologies
• Getting Started
• Roadmap
• Contributing
• License

About The Project

Platform for teachers & students, to offer or search for tutoring.

• User registration with mail confirmation.
• Authorization and authentication.

Technologies

• Java
• SpringBoot
• Maven
• Postgres
• Docker
• Lombok
• Swagger
• Log4j 2
• Git

Getting started

To setup and run this project:

1. Create local PostgreSQL database (name your database "simpleascoding").
2. Overwrite database username and password in application.properties.
3. Build project with maven.

Roadmap

• Implement core functionalities
• Expand database model
• Create documentation

Contributing

For any information about contributions check here.

License

Distributed under the GPL-3.0 License. Check here for more information.