Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/wieczorek1990/slink

Link shortener
https://github.com/wieczorek1990/slink

Last synced: 12 days ago
JSON representation

Link shortener

Awesome Lists containing this project

README

        

Slink
=====

Link shortener service implemented in Python 3 and Django.

# Running

Assuming you have fish shell:

```
./install.fish
./run_dev.fish
```

or

```
docker-compose up
```

Django port is 8000, Docker exposes it to port 80.

# Routes

* `/` - main screen

* `/links/` - link redirection

* `/admin/` - if you use `python3 slink/manage.py createsuperuser`
admin panel is available

# Environment variables

Modify the following either in `run_dev.fish` or `run_prod.fish`.

* `DEBUG` - whether the application runs in debug mode

* `SECRET_KEY` - Django secret key

* `LINK_LENGTH` - generated link lenth

# Checking code style

```
./code_style.fish
```