Simple API for short URL's as part of Challenge Encurtador - Backend made with Adonis 5, PostgreSQL, Docker & Swagger.
The main objective of this repo is to show my skills in creating a simple API documented and tested.
Click here to go to live demo
Clone this repo:
git clone https://github.com/saulowilson/urlshortener-wiser-adonis.git
Then install dependencies using your favorite manager:
npm install --save
or
yarn
Attention: This repo has a .env,example
file included with default necessary variables required by Adonis for a quick start. If you plan to use this project for your own use, make sure that include .env
in your .gitignore
.
This project has a pre-configured PostgreSQL and pgAdmin installation in docker. Run docker-compose up
to build up all environment. Change .env
for custom configuration.
Or run yarn dev
to run locally. PostgreSQL must be installed and running.
To run the tests, run yarn dev
then yarn test
.
Docs are available in route /docs