https://github.com/khinshankhan/pino

An excursion into making an URL shortening service.
https://github.com/khinshankhan/pino

Last synced: about 4 hours ago
JSON representation

An excursion into making an URL shortening service.

• Host: GitHub
• URL: https://github.com/khinshankhan/pino
• Owner: khinshankhan
• License: mit
• Created: 2020-05-22T17:24:56.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-07-18T15:09:04.000Z (over 4 years ago)
• Last Synced: 2023-03-06T04:23:36.471Z (over 1 year ago)
• Language: Go
• Homepage:
• Size: 23.4 KB
• Stars: 3
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.org
  • Contributing: docs/CONTRIBUTING.org
  • License: LICENSE.org
  • Code of conduct: docs/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
#+TITLE: pino

#+STARTUP: overview

An excursion into making an URL shortening service.

* Table of Contents :toc:

- [[#usage][Usage]]

- [[#custom-installation][Custom Installation]]

- [[#etymology][Etymology]]

- [[#code-of-conduct][Code of Conduct]]

- [[#contributing][Contributing]]

- [[#license][License]]

* Usage

  WIP :shipit:

** Setup Docker Compose

  

  Create a =.env= file using =scripts/create-env.sh=. Run this in the root of the project folder.

  #+BEGIN_SRC bash

  $ chmod +x scripts/create-env.sh

  $ bash scripts/create-env.sh

  #+END_SRC

  Start the services.

  #+BEGIN_SRC bash

  $ docker-compose up --build

  #+END_SRC

* Custom Installation

  WIP :shipit:

* Etymology

  In [[https://en.wikipedia.org/wiki/Alice%27s_Adventures_in_Wonderland][Alice's Adventures in Wonderland]], Alice drinks the potion "DRINK ME" to shrink and eats the cake "EAT ME" to

  grow. As we're also messing around with elixir in this excursion, we thought "drink" would be a great name for the

  project. Then, we greek-ified it, and pino kinda makes us think of small, perhaps because of pico or something along

  those lines. Hopefully our project lives up to its name and creates URLs shorter than the original.

* Code of Conduct

  Although code of conducts usually aren't needed, people should think before working with others and likewise people

  should be able to work without stress. Follow our [[file:docs/CODE_OF_CONDUCT.md][code of conduct]] to help maintain a healthy community.

* Contributing

  There are many ways in which you can participate in the project, for example:

  - See an open pull request? You can try reviewing it!

  - Find a pesky bug or perhaps a neat place to refactor? Report it or fix it with a PR!

  - Notice some weird or missing documentation? Fix or add it with a PR!

  Feel free to open a pull request, check our [[file:docs/CONTRIBUTING.org][contributing guide]] for more details.

* License

  This project uses an MIT license, which can be viewed [[file:LICENSE.org][here]].