Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 2 KB

README.md

File metadata and controls

75 lines (51 loc) · 2 KB

ExpressJS URL Shortener

Simple NodeJS Application in which it converts a long URL to a short one using Express JS and Mongoose

Documentation via ApiDoc

Installation

To install the packages

npm install

To create the needed environment variables

touch .env
mongoURI=<MONGO LINK>
baseUrl=<Your domain localhost:5000 or your public domain>

To run the application in the development mode in which it uses nodemon service for auto reload

npm run dev

To run the application in the production mode

npm run start

API Usage

## To convert your long url to a short one
POST localhost:5000/api/url/shorten
BODY longUrl => <YOUR LONG URL>

## To redirect your generated code to a specific link
GET locahost:5000/:code


Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT License

Copyright (c) 2019 Rami Atrouni

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.