https://github.com/PDROJACK/surrealdb-springboot-starter

SurrealDB springboot starter kit
https://github.com/PDROJACK/surrealdb-springboot-starter

Last synced: about 1 month ago
JSON representation

SurrealDB springboot starter kit

• Host: GitHub
• URL: https://github.com/PDROJACK/surrealdb-springboot-starter
• Owner: PDROJACK
• License: mit
• Created: 2023-10-13T22:40:35.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-11-01T06:31:22.000Z (about 1 year ago)
• Last Synced: 2024-08-01T22:43:15.926Z (5 months ago)
• Language: Java
• Size: 627 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-surreal - Starter Kit for SurrealDB + SpringBoot - PDROJACK. (Starter Kits)

README

        
# Starter Kit for SurrealDB + SpringBoot

A starter kit todo app REST API using SpringBoot integrated with Surreal DB.  

## Prerequisites:

- Java 21 and Maven >= 3.8.8

- Docker & Docker compose to start surrealDB if not installed locally.

## Getting Started

1. Clone the Repository:

```bash

git clone https://github.com/PDROJACK/surrealdb-springboot-starter.git

```

2. cd to the backend directory `surrealdb-springboot-starter`.

3. Inside the root of repository directory. Run below command to start SurrealDB:

    

    ```docker compose up```

4. Inside the root of repository directory. Run below command to start SurrealDB:

    

    ```mvn spring-boot:run```

## API Details

1. Postman Collection for the API is present in ```docs/SurrealDB.spring.postman.json```

2. OpenAPI definition can be accessed at this url after starting the app: http://localhost:8080/swagger-ui/index.html#/

![alt text](./docs/openapi.png)

3. [POST] Create Item

![alt text](./docs/post.png)

4. [GET] Get Item by ID

![alt text](./docs/getid.png)

5. [DELETE] Delete Item by ID

![alt text](./docs/deleteid.png)

6. [GET] Get All Items

![alt text](./docs/getall.png)

## Contributing

This starter kit is done as part of Hacketoberfest 2023 project.If you find any issues or have suggestions for improvements, please feel free to open an issue or create a pull request.

Happy coding!