Sisk Short Links [backend]

The back-end for a simple short link generator with optional custom names and expiration settings built in Node.js®

front-end

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

need to have:

• PostgreSQL

Installation

• fork and clone this repository

npm install
createdb <package-name>
npm run seed

• note: package name is asls-backend by default

• create file ./secrets.js in root of project and place the following environment variables in that file

• required environment variables:

process.env.SESSION_SECRET = '<put a nice tasty secret here>';
process.env.SILENT_AUTH_NAME = '<login username>';
process.env.SILENT_AUTH_CHECK = '<login password>';

• optional environment variables (if connecting SMS support via Twilio):

process.env.TWILIO_ACCOUNT_SID = '<get your own>';
process.env.TWILIO_AUTHT_TOKEN = '<from twilio>';

• time to start the server!

npm run start

Built With

• React - A JavaScript library for building user interfaces
• Styled Components - Visual primitives for the component age
• Express - Fast, unopinionated, minimalist web framework for Node.js

Authors

• Adam Sisk - Developer - github | linkedIn

License

This project is licensed under the MIT License

made with ❤️ by Adam Sisk