Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/teknologi-umum/polarite

a Pastebin alternative made for simplicity written in Go.
https://github.com/teknologi-umum/polarite

pastebin pastebin-api teknologi-umum

Last synced: about 2 months ago
JSON representation

a Pastebin alternative made for simplicity written in Go.

Awesome Lists containing this project

README 

        







---





    Polarite is a Pastebin alternative made for simplicity written in Go.




## Usage



### Web Interface

Visit https://polarite.teknologiumum.com



### API



Send a `POST` request to `https://polarite.teknologiumum.com` with:



- `Content-Type` header with the value of `text/plain`

- Non-empty `request body` consisting of the text you want to store

- `Authorization` header with the value of `Your Name ` with a minimum of 15 characters.



Example request:



- cURL

```sh

curl \

    -H "Content-Type: text/plain" \

    -H "Authorization: John Doe " \

    -X POST \

    -d "Hello World" \

    https://polarite.teknologiumum.com/

```



- Javascript (via Fetch API)

```js

fetch("https://polarite.teknologiumum.com/", {

    method: "POST",

    headers: {

        "Content-Type": "text/plain",

        "Authorization": "John Doe "

    },

    body: "Hello world!"

})

```



- Go

```go

import (

    "net/http"

    "strings"

)



func Polarite() {

    body := strings.NewReader("Hello world")

    req, err := http.NewRequest(http.MethodPost, "https://polarite.teknologiumum.com/", body)

    req.Header.Add("Content-Type", "text/plain")

    req.Header.Add("Authorization", "John Doe ")



    client := &http.Client{}

    resp, err := client.Do(req)

}

```



- C#

```c#

using System.Net.Http;



var client = new HttpClient();

var request = new HttpRequestMessage() {

    RequestUri = new Uri("https://polarite.teknologiumum.com/"),

    Method = HttpMethod.Post,

    Headers = {

        { "Authorization", "John Doe " },

        { "ContentType", "text/plain" }

    },

    Content = new StringContent("Hello world", Encoding.UTF8, "text/plain")

};



var task = await client.SendAsync(request);

```



### Available Options



Polarite uses [alecthomas/chroma](github.com/alecthomas/chroma). You can pass

some options to the highlighter by appending these parameters in the URL.

If none of these options are passed, you will get a plain text without any highlighting



- `lang`



    This option decides which language to use. See [alecthomas/chroma#supported-languages](https://github.com/alecthomas/chroma/#supported-languages) for supported languages.



    - `https://polarite.teknologiumum.com/your-unique-id?lang=go`

    - `https://polarite.teknologiumum.com/your-unique-id?lang=rust`



- `theme`



    This option decides which theme to use. The default theme is dracula.



    - `https://polarite.teknologiumum.com/your-unique-id?theme=monokai`

    - `https://polarite.teknologiumum.com/your-unique-id?theme=nord`



    

        Click here to see all valid themes



     - abap

     - algol

     - algol_nu

     - arduino

     - autumn

     - base16-snazzy

     - bw

     - borland

     - colorful

     - doom-one

     - doom-one2

     - dracula

     - emacs

     - friendly

     - fruity

     - github

     - hrdark

     - hr_high_contrast

     - igor

     - lovelace

     - manni

     - monokai

     - monokailight

     - murphy

     - native

     - nord

     - onesenterprise

     - paraiso-dark

     - paraiso-light

     - pastie

     - perldoc

     - pygments

     - rainbow_dash

     - rrt

     - solarized-dark

     - soldarized-dark256

     - solarized-light

     - swapoff

     - tango

     - trac

     - vim

     - vs

     - vulcan

     - xcode

     - xcode-dark

    



- `linenr`



    This option decides whether to enable line number or not. A non empty value is considered as true.



    - `https://polarite.teknologiumum.com/your-unique-id?linenr=yes`

    - `https://polarite.teknologiumum.com/your-unique-id?linenr=true` This is also valid



You can, of course, combine the options.

For example: `https://polarite.teknologiumum.com/your-unique-id?lang=rust&theme=nord&linenr=true`



## Why the name, Polarite?



In the dawn of time, it began with the birth of [Graphene](https://github.com/teknologi-umum/graphene) repository, which its' name was picked from the name of a mineral.

Then, not so long after, another repository called [Flourite](https://github.com/teknologi-umum/flourite) emerged. It's actually a typo of Fluorite, another name of a mineral.

Now, where mankind stands, we want to continue that convention, to pick a name from a [list of mineral on Wikipedia](https://en.wikipedia.org/wiki/List_of_minerals).



## License



```

   Copyright 2021-present Teknologi Umum 



   Licensed under the Apache License, Version 2.0 (the "License");

   you may not use this file except in compliance with the License.

   You may obtain a copy of the License at



       http://www.apache.org/licenses/LICENSE-2.0



   Unless required by applicable law or agreed to in writing, software

   distributed under the License is distributed on an "AS IS" BASIS,

   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

   See the License for the specific language governing permissions and

   limitations under the License.

```



See [LICENSE](./LICENSE)