Skip to content

larissaevaldt/urlshortenerapp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

urlshortenerapp

PRs welcome! GitHub license Follow larissaevaldt

About

💡 This project is an API for short URL creation

Built With

Installation

With Docker installed, run the following commands:

$ git clone https://github.com/larissaevaldt/urlshortenerapp.git
$ cd urlshortenerapp
$ docker-compose up

Usage

Request Method URI Body (JSON) Description
GET http://localhost/api/v1/{code} - Retrieve original URL and redirect user to the correct Website
POST http://localhost/api/v1 { "longUrl": "https://siteyouwant" } Create a unique short URL and return it in the response body

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Larissa Evaldt - https://www.linkedin.com/in/larissaevaldt/ - [email protected]

Project Link: https://github.com/larissaevaldt/urlshortenerapp

About

An API for short URL creation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published