Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nprail/url-shortener

WIP: A simple and modern URL shortener built with MEAN for easy deployment to Heroku!
https://github.com/nprail/url-shortener

expressjs heroku mongodb nodejs url-shortener

Last synced: about 10 hours ago
JSON representation

WIP: A simple and modern URL shortener built with MEAN for easy deployment to Heroku!

Awesome Lists containing this project

README

        

# MEAN URL Shortener [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/nprail/url-shortener/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/nprail/url-shortener.svg)](https://github.com/nprail/url-shortener/releases) [![dependencies Status](https://david-dm.org/nprail/url-shortener/status.svg)](https://david-dm.org/nprail/url-shortener)
A simple and modern URL shortener built with MEAN for easy deployment to Heroku!

## Goals
- Simple
- Built for Easy Deployment to Heroku
- User Authentication
- [Robust API](http://docs.nprailurlshortener.apiary.io)

## Quickstart
MEAN URL Shortener is built for easy self hosting. For hosting on Heroku, all you have to do is click the button below then set the settings! Simple as that!

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Documentation

You can find MEAN URL Shortener's documentation here:

- [Wiki](https://github.com/nprail/url-shortener/wiki)
- [API Docs](http://docs.nprailurlshortener.apiary.io)

## Stack
- MEAN
- MongoDB
- Express.js
- Handlebars.js
- AngularJS
- Node.js
- Bootstrap

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/nprail/url-shortener/releases).

## Authors

- **Noah Prail** - _Project Lead_ - [@nprail](https://github.com/nprail)

See also the list of [contributors](https://github.com/nprail/url-shortener/contributors) who participated in this project.
## License
```
MIT License

Copyright (c) 2018 Noah Prail

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.
```