gitpad/README.md

<div align="center">
<h1> Gists </h1>
<p>

**Self-Hosted GitHub Gists**

</p>

[![Build](https://github.com/realaravinth/gists/actions/workflows/linux.yml/badge.svg)](https://github.com/realaravinth/gists/actions/workflows/linux.yml)
[![dependency status](https://deps.rs/repo/github/realaravinth/gists/status.svg)](https://deps.rs/repo/github/realaravinth/gists)
[![codecov](https://codecov.io/gh/realaravinth/gists/branch/master/graph/badge.svg)](https://codecov.io/gh/realaravinth/gists)

</div>

## Features

-   [ ] Upload code snippets(&check; REST API)
-   [ ] Syntax Highlighting
-   [ ] Comments
-   [x] Versioning through Git
-   [ ] Fork gists
-   [x] Gist privacy: public, unlisted, private
-   [ ] Git clone via HTTP and SSH
-   [ ] Activity Pub implementation for publishing native gists and commenting
-   [ ] Gitea OAuth integration

## Why?

Gists are nice, while there are wonderful forges like
[Gitea](https://gitea.io), there isn't a libre pastebin implementation that
can rival GitHub Gists.

## Usage

1. All configuration is done through
   [./config/default.toml](./config/default.toml)(can be moved to
   `/etc/gists/config.toml`).
add readme 2022-02-11 12:11:54 +00:00			`<div align="center">`
			`<h1> Gists </h1>`
			`<p>`

feat: add gists_gists, gists_comments and gists_comments & related methods The following changes are implemented for both db-sqlx-postgres and db-sqlx-sqlite: TABLE gists_gists Stores gist metadata with unique index on gists_gists.public_id for fast lookups TABLE gists_comments Stores comment metadata TABLE gists_privacy Stores gist privacy: sqlx currently doesn't have support Postgres enums(ref: https://github.com/launchbadge/sqlx/issues/1171), so storing possible privacy values as references from this table. This table shouldn't be mutated during runtime. Possible values are already recorded in database during migrations. All runtime operations on this table must only take references. Each implementation of GistDatabase also includes a method called privacy_exists, which is called during tests to ensure that migrations are successful. VIEW gists_gists_view Gist lookups combines data from gists_users, gists_gists and gists_privacy. This SQL view boots performance(I think?). At any rate, it is much nicer to work with. QUIRKS Database indexes are i64 in SQLite while i32 in Postgres 2022-02-14 14:29:32 +00:00			`Self-Hosted GitHub Gists`
add readme 2022-02-11 12:11:54 +00:00
			`</p>`

			`[![Build](https://github.com/realaravinth/gists/actions/workflows/linux.yml/badge.svg)](https://github.com/realaravinth/gists/actions/workflows/linux.yml)`
			`[![dependency status](https://deps.rs/repo/github/realaravinth/gists/status.svg)](https://deps.rs/repo/github/realaravinth/gists)`
			`[![codecov](https://codecov.io/gh/realaravinth/gists/branch/master/graph/badge.svg)](https://codecov.io/gh/realaravinth/gists)`

			`</div>`

			`## Features`

feat: update todo list 2022-02-18 18:29:37 +00:00			`- [ ] Upload code snippets(&check; REST API)`
add readme 2022-02-11 12:11:54 +00:00			`- [ ] Syntax Highlighting`
			`- [ ] Comments`
feat: update todo list 2022-02-18 18:29:37 +00:00			`- [x] Versioning through Git`
add readme 2022-02-11 12:11:54 +00:00			`- [ ] Fork gists`
feat: update todo list 2022-02-18 18:29:37 +00:00			`- [x] Gist privacy: public, unlisted, private`
feat: add git SSH and HTTP clone feature target in README 2022-02-12 18:18:21 +00:00			`- [ ] Git clone via HTTP and SSH`
add readme 2022-02-11 12:11:54 +00:00			`- [ ] Activity Pub implementation for publishing native gists and commenting`
feat: add gitea oauth integration to feat list 2022-02-18 07:15:43 +00:00			`- [ ] Gitea OAuth integration`
add readme 2022-02-11 12:11:54 +00:00
			`## Why?`

			`Gists are nice, while there are wonderful forges like`
			`[Gitea](https://gitea.io), there isn't a libre pastebin implementation that`
			`can rival GitHub Gists.`

			`## Usage`

			`1. All configuration is done through`
			`[./config/default.toml](./config/default.toml)(can be moved to`
feat: add gists_gists, gists_comments and gists_comments & related methods The following changes are implemented for both db-sqlx-postgres and db-sqlx-sqlite: TABLE gists_gists Stores gist metadata with unique index on gists_gists.public_id for fast lookups TABLE gists_comments Stores comment metadata TABLE gists_privacy Stores gist privacy: sqlx currently doesn't have support Postgres enums(ref: https://github.com/launchbadge/sqlx/issues/1171), so storing possible privacy values as references from this table. This table shouldn't be mutated during runtime. Possible values are already recorded in database during migrations. All runtime operations on this table must only take references. Each implementation of GistDatabase also includes a method called privacy_exists, which is called during tests to ensure that migrations are successful. VIEW gists_gists_view Gist lookups combines data from gists_users, gists_gists and gists_privacy. This SQL view boots performance(I think?). At any rate, it is much nicer to work with. QUIRKS Database indexes are i64 in SQLite while i32 in Postgres 2022-02-14 14:29:32 +00:00			`/etc/gists/config.toml`).