Skip to content

Ze-Austin/scissor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License Twitter




Table of Contents
  1. About Scissor
  2. Lessons Learned
  3. Usage
  4. Sample
  5. License
  6. Contact
  7. Acknowledgements

back to top


About Scissor

Scissor is a simple tool which makes URLs as short as possible, as "brief is the new black" in the age of social media.

Scissor converts long URLs into easily sharable QR codes and short, customizable links.

This tool was built as a capstone project by Ze Austin, a Backend Engineering student at AltSchool Africa who's learning to create magic with Python.

Live Site: sciz.site

Full Documentation: Scissor Wiki

back to top

Built With:

Python Flask Jinja HTML5 CSS3 SQLite

back to top


Lessons Learned

Creating this tool helped to learn and practice:

  • Responsive Web Design
  • URL Shortening
  • QR Code Generation
  • Rate Limiting
  • Caching
  • Debugging
  • Routing
  • Database Management
  • Internet Security
  • User Authentication
  • User Authorization
  • Message Flashing
  • Documentation

back to top


Usage

This tool can be accessed via the deployed site or a local copy of the project.

Live Link

Deployed site: sciz.site - hosted via render

Localhost

To get a local copy up and running, follow the steps below.

Prerequisites

Python3: Get Python

Installation

  1. Clone this repo
    git clone https://github.com/Ze-Austin/scissor.git
  2. Activate the virtual environment
    source scissor/bin/activate
  3. Install project packages
    pip install -r requirements.txt
  4. Run Flask
    flask run
  5. Open the link generated in the terminal on a browser

back to top


Sample


Scissor Screenshot




Dashboard Screenshot


back to top


License

Distributed under the MIT License. See LICENSE for more information.

back to top


Contact

Dr Austin Wopara - @Ze_Austin - austinwopara@gmail.com

Live Site: sciz.site

Project Link: Scissor Repo

Documentation: Scissor Wiki

back to top


Acknowledgements

This project was made possible by:

back to top