Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/azu/memory-note
Fast memory note on CDN edge. Cloudflare Workers KV/GitHub Projects as backend.
https://github.com/azu/memory-note
api cloudflare githubproject ios mac notes
Last synced: 22 days ago
JSON representation
Fast memory note on CDN edge. Cloudflare Workers KV/GitHub Projects as backend.
- Host: GitHub
- URL: https://github.com/azu/memory-note
- Owner: azu
- License: mit
- Created: 2021-08-29T14:16:02.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-08-22T02:55:49.000Z (about 1 year ago)
- Last Synced: 2024-10-03T12:19:47.283Z (about 1 month ago)
- Topics: api, cloudflare, githubproject, ios, mac, notes
- Language: TypeScript
- Homepage:
- Size: 2.62 MB
- Stars: 48
- Watchers: 2
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Memory Note
Fast memory note for your brain.
Memory Note is an app like reminder.app, but it does not have frontend.
You can create and customize frontend and backend.
In other words, Memory Note is programmable todo-app middleware.
## Features
- Fast - Work on CDN Edges
- Memory Notes works on [Cloudflare Workers](https://workers.cloudflare.com/)
- Customizable Backend - Create own backend
- You can use Cloudflare Worker KV or GitHub Projects as backend
- Also, you can create own backend by implementing 3 APIs
- Flexible Frontend - Memory Notes interface is just REST API. You can create any frontend
- iOS shortcut.app, iOS Widgets, Alfred Workflow
### Screenshots
> use GitHub Project Board as backend
> iOS Widgets using [Web Widget](https://apps.apple.com/jp/app/web-widget-webpage-screenshot/id1561605396) and Siri
> integrations
> Alfred workflow integration
## Usage
Requirements: [Cloudflare](https://www.cloudflare.com/) account
1.
Click [](https://deploy.workers.cloudflare.com/?url=https://github.com/azu/memory-note)
2. Deploy memory-note
3. Set *Environment Variables* to your Memory Note workers
- You need to choose a backend from `cloudflare` or `github` for your Memory Note
### Environment Variables
- `MEMORY_NOTE_TOKEN`: It is random value. This is used for authorization.
- You need to access your memory note using `?token=`.
- You can use random password generator like
- `BACKEND_SERVICE`: backend service
- `github` or `cloudflare` is supported
- Default: `cloudflare`
- Other vars is defined in each Backend Service
:memo: all values should be encrypted.
### Backend Service
Currently, Memory Note supports following backend:
- `cloudflare`: Cloudflare Workers KV
- `github`: GitHub Project Board
- `notion`: Notion
You can choose a backend.
:memo: If you want to add new backend, please submit Pull Request!
[StorageAdapter.ts](./src/note/StorageAdapter.ts) is an interface for backend.
#### `cloudflare` backend
You need to create KV Binding.
1. Visit `https://dash.cloudflare.com/{your account id}/workers/kv/namespaces`
2. Add new Namespace like `MY_MEMORY_NOTE`
3. Visit `https://dash.cloudflare.com/{your account id}/workers/view/memory-note/settings`
4. Add new KV Namespace Bindings
- `Variable name`: `MEMORY_NOTE`
- `KV namespace`: created KV Namespace(`MY_MEMORY_NOTE`)
5. Add new Environment Variables
- `MEMORY_NOTE_TOKEN`
- `Variable name`: `MEMORY_NOTE_TOKEN`
- `Value`: your defined random password
- `BACKEND_SERVICE`
- `Variable name`: `BACKEND_SERVICE`
- `Value`: `cloudflare`
#### `github` backend
You need to create GitHub Projects Board and Get your GitHub API Token
**1. Create Project and Get Column Id**
1. Create a GitHub Repository
2. Create a GitHub Project on the repository
-
3. Create a column like "Memory Note"
4. Copy Column link
5. Get Column id from the copied link
This **Column id** is `:listId` value of API endpoint.
For example, if column link is `https://github.com/yourname/yourrepo/projects/1#column-1111111`, `1111111`
is `column_id`. You need to copy it.
You can use the column id as `:listId`.
```bash
$ curl https://example-memory-note.worker.dev/notes/1111111?token=random-password
```
**2. Get GitHub API Token**
1. Visit
2. Create new API Token
- permissions: `repo`
3. Copy it
**3. Add Environments Variables to Cloudflare Workers**
Add some Environment Variables.
Visit `https://dash.cloudflare.com/{your account id}/workers/view/memory-note/settings`
- `MEMORY_NOTE_TOKEN`
- `Variable name`: `MEMORY_NOTE_TOKEN`
- `Value`: your defined random password
- `BACKEND_SERVICE`:
- `Variable name`: `BACKEND_SERVICE`
- `Value`: `github`
- `GITHUB_OWNER`:
- `Variable name`: `GITHUB_OWNER`
- `Value`: your GitHub account name
- `GITHUB_REPO`:
- `Variable name`: `GITHUB_REPO`
- `Value`: your GitHub repository name
- `GITHUB_PROJECT_ID`
- `Variable name`: `GITHUB_PROJECT_ID`
- `Value`: your GitHub Project id
- `GITHUB_TOKEN`
- `Variable name`: `GITHUB_TOKEN`
- `Value`: your GitHub API token
For example, if you have used `https://github.com/your/my-note/projects/1` repo, you need to set `GITHUB_OWNER=your`
and `GITHUB_REPO=my-note`, and `GITHUB_PROJECT_ID=1`.
### Notion backend
You need to create Notion Database and Get your Notion API Token
- `NOTION_TOKEN`=`""`
- `NOTION_MESSAGE_PROPERTY_NAME`=`""`
You need to pass Notion Database ID as `:listId` value of API endpoint.
- `GET /notes/`
- `POST /notes//new`
````
https://www.notion.so/myworkspace/a8aec43384f447ed84390e8e42c2e089?v=...
| --------- Database ID --------|
````
Optional:
- `NOTION_FILTER_OPTIONS`=`'{"name":"","type": "type": "", "value":""}'`
`NOTION_FILTER_OPTIONS` is a JSON string of `NotionFilterOption[]`.
It will filter notes by `PROPERTY_NAME` and `PROPERTY_VALUE`.
```ts
export type NotionFilterOption =
| {
name: string;
type: "checkbox";
value: string;
}
| {
name: string;
type: "relation";
value: string;
}
| {
name: string;
type: "select";
value: string;
op?: "equals" | "does_not_equal";
}
| {
name: string;
type: "status";
value: string;
op?: "equals" | "does_not_equal";
};
```
Examples:
```
# filter category and checkbox
NOTION_FILTER_OPTIONS='[{"name":"category","type":"select","value":"test"},{"name":"done","type":"checkbox","value":false}]'
```
```
# filter relation and checkbox
NOTION_FILTER_OPTIONS='[{"name":"ref","type":"relation","value":"xxxx-id--id"},{"name":"done","type":"checkbox","value":false}]'
```
## API
Memory-Note provides following API.
### `GET /notes/:listId`
Return an array of notes.
Parameters:
- `:listId`: note key. This use-case is defined by adapter.
- on `github`: your project column id
- on `cloudflare`: any string
Query:
- `?limit`: result item count
- `&token`: Your Memory Note token
Example:
```
# curl https://{your worker}/notes/{your GitHub Project Column Id}?token={your Memory Note Token}
$ curl https://example-memory-note.worker.dev/notes/11111?token=random-password
```
### `GET /notes/:listId/txt`
txt version of `/notes/:listId`.
The response is like following:
```
note
note
note
```
### `GET /notes/:listId/widget`
Return simple html page for widgets.
You can show your notes on Widgets app
like [Web Widget](https://apps.apple.com/jp/app/web-widget-webpage-screenshot/id1561605396).
### `POST /notes/:listId/new`
Post a note that following json data.
```typescript
type NoteBody = {
message: string;
};
```
Example of post data.
```json
{
"message": "test"
}
```
Parameters:
- `:listId`: note key. This use-case is defined by adapter.
Query:
- `?token`: Your Memory Note token
### `PUT /notes/:listId/:noteId`
Edit a note with the `:noteId`
```typescript
type NoteBody = {
message: string;
};
```
Example of post data.
```json
{
"message": "test"
}
```
Parameters:
- `:listId`: note key. This use-case is defined by adapter.
- `:noteId`: note id. you can get the id from GET api
Query:
- `?token`: Your Memory Note token
### `DELETE /notes/:listId/:noteId`
Delete the note.
Parameters:
- `:listId`: note key. This use-case is defined by adapter.
- `:noteId`: note id. you can get the id from GET api
Query:
- `?token`: Your Memory Note token
### `POST /notes/:listId/move/:noteId`
Move the note to another list.
- `:listId`: note key. This use-case is defined by adapter.
- `:noteId`: note id. you can get the id from GET api
Body:
- `to`: to list id
```shell
{
"to": "another list id"
}
```
## Clients
You can use client app for Memory Note.
### Alfred
Alfred workflow can show notes in large types, add a new note, remove a note.
- Download [memory-note.workflow](docs/alfred/memory-note.alfredworkflow)
- Set [Workflow Variables](https://www.alfredapp.com/help/workflows/advanced/variables/)
[Workflow Variables](https://www.alfredapp.com/help/workflows/advanced/variables/)
- `API_ENDPOINT`: your cloudflare worker url
- Example, `https://my-memory-note.you.workers.dev`
- `API_TOKEN`: your memory note token
- `LIST_ID`: your main `:listId`
### iOS shortcuts.app:
iOS shortcut can create a new note using voice(siri), read out notes.
- Add note using voice to memory note:
- Read memory note:
:memo: You input `worker url` and `:listId` and `memory note token` after installing the workflow
### Others
- [ ] Please submit a Pull Request
## Contributing
1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D
## License
MIT