https://github.com/mishnit/shorts
A microservice for shortening Long URLs to short Emoji URLs
https://github.com/mishnit/shorts
docker flask graphql postgresql python3
Last synced: 3 months ago
JSON representation
A microservice for shortening Long URLs to short Emoji URLs
- Host: GitHub
- URL: https://github.com/mishnit/shorts
- Owner: mishnit
- Created: 2019-07-30T07:57:40.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-07-30T11:25:01.000Z (almost 7 years ago)
- Last Synced: 2025-02-22T07:14:38.975Z (over 1 year ago)
- Topics: docker, flask, graphql, postgresql, python3
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 😎 Shorts- URl shortening service
This service will take a standard URL, and return a much shorter URL comprised of a hand-selected set of very special emoji characters.
This API is built with `Python 3.6`, `Flask 1.0.3`, `Graphene 2.1.3`, `SQLAlchemy 1.3.3` and `PostgreSQL 9.6`.
__Endpoints:__
*GraphQL*
* GraphQL interface is available at `http://localhost:3001/graphql/`
*Query*
```
{
redirectForSlug (slug: "💃😕")
slugs
}
```
* `slugs` returns a list of all short urls currencly registered
* `redirectForSlug` return the redirect URL for a given slug
*Mutation*
```
mutation myFirstMutation {
createShortUrl(redirectUrl: "https://github.com/mishnit/shorts") {
short
ok
}
}
```
*REST*
* GET `/` return a http redirect (302) if an associated URL is found.
* POST `/` posting a request containing a body of `{url: }` will result in the creation of your own short silly emoji URL that you can share with your friends.
### 🙈 Caveats
This is a small example service demonstrating flask, sqlalchemy, and graphQL. There aren't many tests,
and I'm not adhering to strict pep8. I've considered scalability, performance, and security, and
look forward to discussing my choices.
At the moment this is a backend service only, responding to GraphQL or REST requests. I might throw together a quick React frontend and add CORS support if I find spare time.
In all seriousness this is not a great idea for general URL shortening, as many browsers and middleware technologies still have a difficult time with emoji characters. Still fun though. 👯
### 😼 Dependencies
* docker:
```
sudo apt-get update
sudo apt-get remove docker docker-engine docker.io (Uninstall Old Versions of Docker)
sudo apt install docker.io
sudo systemctl start docker
sudo systemctl enable docker
docker --version
sudo chown $USER:docker /var/run/docker.sock
```
* docker-compose:
```
sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose
sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose
docker-compose --version
```
### 🚀 Start it up
* run `./bin/start.sh` to build images, run containers and start the server on 127.0.0.1:3001