Skip to content

A simple URL shortener server backed by PostgreSQL.

License

Notifications You must be signed in to change notification settings

swan-io/url-shortener

Repository files navigation

Swan URL shortener

A simple URL shortener server backed by PostgreSQL.

Getting started

You need to install yarn.

Clone

$ git clone [email protected]/swan-io/url-shortener.git

Install

$ yarn

Environment variables

At the project root, you should find a .env.example file. Copy its contents to a new .env file.

Development

To start the development server, run:

$ yarn dev

Building

To build the production codebase, run:

$ yarn build

Testing

Run tests (using vitest and pgmock):

$ yarn test