Giter Club home page Giter Club logo

url-shortener's Introduction

URL-shortener

A simple project creates a URL shortener service, implementing a clean architecture and using Nestjs, Docker, PostgreSQL, and Redis.

Create a .env.json file

This project uses an env file instead common .env file (to experiment with using more types, like array or embedded objects) So you need to create a .env.json file before running the project, you could use the provided example:

$ cp .env.example.json .env.json

Running the Development Environment

In docker/dev

$ docker-compose up

This application was built implementing Clean Architecture, each module represents a domain and each domain has its respective layers, it is also the reason why there is so much abstraction between layers.

The seeders will be automatically executed the first time the project is started.

The env vars are stored in .env.json, if you modify them maybe you need to modify some variable values in the docker-compose.

Also, you can check the swagger http://localhost:4000/api-docs/ to inspect the API contracts and execute the request (except the redirect one, to test that you need to execute it in the browser directly)

Do not hesitate to ask any questions you may have.

url-shortener's People

Contributors

kb05 avatar

Watchers

 avatar Agustin Isasmendi avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.