Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/storycraft/pancake-resource-locator

Pancake Resource Locator
https://github.com/storycraft/pancake-resource-locator

Last synced: 22 days ago
JSON representation

Pancake Resource Locator

Host: GitHub
URL: https://github.com/storycraft/pancake-resource-locator
Owner: storycraft
License: gpl-3.0
Created: 2022-12-21T08:20:15.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2023-01-10T10:58:51.000Z (almost 2 years ago)
Last Synced: 2024-10-30T01:47:13.521Z (2 months ago)
Language: Java
Size: 348 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Pancake Resource Locator
Modular URL Shortener

## Requirement
* MySQL
* Java web application server supporting Jakarta EE (Previsouly Java EE)
* Java 8+

## Build
To build projects run
```bash
./gradlew build
```

## Running

### API Server
To run api server you need to provide these environment variable
* `DB_URL` JDBC database url
* `DB_USERNAME` Database username
* `DB_PASSWORD` Database user password
* `JWT_SECRET` Server secret value

### Redirect Server
To run redirect server you need to provide these environment variable
* `DB_URL` JDBC database url
* `DB_USERNAME` Database username
* `DB_PASSWORD` Database user password

### Database
Pancake Resource Locator is using `flyway` for database migration

Before running migration, supply database informations using enviroment variable
* `DB_URL` JDBC database url
* `DB_USERNAME` Database username
* `DB_PASSWORD` Database user password

Run this command to perform migration
```bash
./gradlew database:migrate
```

## Structure
![Big Picture](./resources/big%20picture.svg)
* See `server-core` directory for core server api
* See `api-server` directory for API server impl
* See `web` directory for Pancake Resource Locator web impl
* See `redirect-server` directory for redirection server impl

## License
Pancake Resource Locator is licensed under GPLv3