Oh-My-Backend

Designed for students by students

The REST-API of Oh-My-Web

What is OMB?

Oh-My-Backend is a standalone opensource REST-API class-management system.

In other words:

You can build your own implementation for a client or just use the already existing Oh-my-Web;
A web-app built with React, TypeScript and lots of love! ❤️

How-to's

Start the REST-API

1. Clone repository

2. Start the database server

1. Open a Terminal and navigate to the project's root
2. Run docker compose up -d to start the database
3. Or: Feel free to use any MySQL database
   • Just make sure it's running on ___:3306
   • If this is not the case, edit the spring.datasource.url to match your port in theapplication.yml file
4. Create a database table called 'ohmyclass'

3. Start OhMyClass.Application

• Via IntelliJ:
  • Locate OhMyClass.java and hit the run button
• Via maven:
  • Locate the project's root and run mvn spring-boot:run

Send requests

• Postman
  • Import the requests and environment files into postman /documentation/postman
• [...]
  • [...]