shrtnr is an application that creates short links and captures visit metrics similar to bit.ly. This repo serves to document the project and provide a single docker-compose.yml file to build and run the project. The application is composed of code from the following github repos:
To learn more about the application architecture and implementation, read through the docs linked below:
| Doc | Description |
|---|---|
| Architecture | An overview of the application architecture and the major components. |
| App | An overview of the app component. |
| API | An overview of the app component. |
Follow the steps in this section to setup and run the application locally using docker.
- You have docker installed on your device.
- Build the docker containers
docker compose build
- Run the project in docker
docker compose up
- Naviagte to localhost:3000
Adminer is a browser based database management tool. Use the follow credentials to connect to the shrtnr database.
| Field | Value |
|---|---|
| System | PostgreSQL |
| Server | db |
| Username | shrtnr |
| Password | password |
| Database | shrtnr |