url-shortener/README.md

28 lines
765 B
Markdown

# simple url shortener
this project is a simple solution to build out a URL shortener using
Roda, Falcon, Sequel, and SQLite
the point of this project is to quickly build something and work on continuous deployment while making small refinements to the functional pieces.
first you have to install the dependencies:
`bundle install`
if you want the development group included run this first:
`bundle config set --local with 'development'
then create a .env.rb file in the root directory that contains the following ENV attributes:
APP_SESSION_SECRET
DB_NAME
after the dependencies are installed, you have to create the db
`sequel -m db/migrations sqlite://db/{DB_NAME}`
to start the application with Falcon:
`rackup -o {ip address} -p {port} -s falcon`