https://github.com/melizeche/get-shorty

A simple URL shortener written in Flask
https://github.com/melizeche/get-shorty

flask python url-shortener

Last synced: 3 months ago
JSON representation

A simple URL shortener written in Flask

• Host: GitHub
• URL: https://github.com/melizeche/get-shorty
• Owner: melizeche
• License: mit
• Created: 2017-04-18T11:05:33.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-07-16T09:14:33.000Z (6 months ago)
• Last Synced: 2024-10-15T00:55:00.378Z (3 months ago)
• Topics: flask, python, url-shortener
• Language: Python
• Homepage:
• Size: 25.4 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flask-get-shorty

A simple URL shortener capable of redirect to diferent targets according to the user device(desktop, mobile, tablet) written in Flask

## Requirements

* Python 3.5+

* Flask 0.12.1

## Installation

Virtualenv is optional but strongly suggested

```

git clone [email protected]:melizeche/get-shorty.git

cd get-shorty

virtualenv env -p python3.5

source env/bin/activate

pip install -r requirements.txt

```

## Usage

```

export FLASK_APP='getshorty.py'

flask initdb

flask run -h 0.0.0.0 -p 5000

```

## API Docs

 see the [API.md](API.md) file for details

## Running the tests

```

python tests_shorty.py

```

## Contributing

1. Fork it!

2. Create your feature branch: `git checkout -b my-new-feature`

3. Commit your changes: `git commit -am 'Add some feature'`

4. Push to the branch: `git push origin my-new-feature`

5. Submit a pull request :D

## TODO

* More Tests

* ~~Proper~~ Extend documentation

* Use flask blueprints for api versioning

## Credits

* Marcelo Elizeche Landó

## License

This project is licensed under the terms of the MIT license - see the [LICENSE](LICENSE) file for details