https://github.com/arnaudjuracek/internet

Personal homepage
https://github.com/arnaudjuracek/internet

Last synced: 13 days ago
JSON representation

Personal homepage

• Host: GitHub
• URL: https://github.com/arnaudjuracek/internet
• Owner: arnaudjuracek
• Created: 2022-01-29T18:52:15.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-04-05T11:18:06.000Z (almost 2 years ago)
• Last Synced: 2024-11-06T23:45:38.502Z (2 months ago)
• Language: JavaScript
• Homepage: https://internet.arnaudjuracek.fr/
• Size: 415 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# internet 

**Get/set bookmarks and articles from anywhere**




## Usage

```console

$ curl -X POST -H 'Authorization: Basic API_TOKEN' -H 'Content-Type: application/json' --data '{ "url": "https://example.com" }' …/api/bookmark

```

### API

| method | endpoint | body | description |

| :----- | :------- | :--- | :---------- |

| `POST`  | `/api/article` | `{ url }` | Add a new article |

| `PATCH` | `/api/article` | `{ url, title }` | Rename an article |

| `PATCH` | `/api/article/archive` |  `{ url }` | Archive an article |

| `DELETE` | `/api/article` | `{ url }` | Delete an article |

| `POST`  | `/api/bookmark` | `{ url }` | Save a new bookmark |

| `PATCH` | `/api/bookmark` | `{ url }` | Rename a bookmark |

| `DELETE` | `/api/bookmark` | `{ url }` | Delete a bookmark |

## Development

### Installation

```console

$ git clone https://github.com/arnaudjuracek/internet && cd internet

$ cp server/.env.example server/.env

$ yarn install

```

### Deployment

Deployment to the AlwaysData environment is done automatically via a [Github action](.github/workflows/deploy-alwaysdata.yml). Simply create a new release by running:

```console

$ yarn version

```

## License

[MIT.](https://tldrlegal.com/license/mit-license)