https://github.com/deseteral/pudeuko

📦 Save internet things to check out later
https://github.com/deseteral/pudeuko

dropbox microservice productivity rest

Last synced: 22 days ago
JSON representation

📦 Save internet things to check out later

• Host: GitHub
• URL: https://github.com/deseteral/pudeuko
• Owner: Deseteral
• License: mit
• Created: 2019-01-30T17:46:38.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-22T11:07:02.000Z (about 3 years ago)
• Last Synced: 2025-02-07T17:17:50.804Z (2 months ago)
• Topics: dropbox, microservice, productivity, rest
• Language: TypeScript
• Homepage:
• Size: 311 KB
• Stars: 3
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pudeuko

![Build Status](https://github.com/Deseteral/pudeuko/workflows/Build/badge.svg)

REST service for storing internet things (or... links 🤔) you wish to check out later.

# Development

```sh

npm install

npm run build

npm start # to run service

npm test  # to run tests

```

## Endpoints

`GET /pudeuko` \

Returns your pudeuko object containing your saved items (in `item` array) and archived ones (in `archive` array).

`POST /pudeuko` \

Accepts `application/json` \

Example body: `{ "text": "Check out this link https://example.com/cool_content" }` \

Parses string content containing link to save. That link is being transformed into an item and saved to data storage.

`GET /pudeuko/` \

Returns an item for given `id`.

`DELETE /pudeuko/` \

Archives an item if it is found by given `id`.

## Data storage

`pudeuko` uses Dropbox as it's data storage. To run the app you have to provide Dropbox app token via `DROPBOX_TOKEN`

environment variable.

The data is saved in a single JSON file located at `/pudeuko/data.json`.

## License

This project is licensed under the [MIT license](LICENSE).