Skip to content

*WIP* API for DSEC Basecamp. Built to enable applications which interact with DSEC member generated content.

Notifications You must be signed in to change notification settings

dsec-hub/dsec-basecamp-api

Repository files navigation

DSEC Basecamp API WIP

Basecamp is a web application available to all DSEC members that encourages collaboration and learning outside of the classroom.

This repository stores the source code for an API for DSEC Basecamp. Built to enable applications which interact with DSEC member generated content.

Quick Start (Local Development)

  1. run docker-compose up -d
  2. make api calls to http://localhost:8080/

Documentation

Documentation implemented using Swagger OpenAPI.

  • http://localhost:8080/api-docs
  • http://localhost:8080/swagger-ui/index.html

Acquiring Authentication

To call any endpoint from this API a JWT token is required, acquired from AWS Cognito.

Auth URL: https://ap-southeast-2r46bdzlr2.auth.ap-southeast-2.amazoncognito.com/login Access Token URL: https://ap-southeast-2r46bdzlr2.auth.ap-southeast-2.amazoncognito.com/oauth2/token

Tech Stack

  • Java 21+
  • Spring Boot 4.0.0
  • PostgreSQL 14.19

Architecture

The logical architecture of the application follows Hexagonal (Ports and Adaptors) Architecture.

About

*WIP* API for DSEC Basecamp. Built to enable applications which interact with DSEC member generated content.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published