Srtt.me

Srtt.me is a URL shortener built with MEAN Stack. It is currently under development. Feel free to contribute.

https://srtt.me

Table of Contents

• Features
• Technologies
• Setup
• API
• Contributing

Features

• Free and open source.
• Short URLs in one click.
• Custom URLs. (Coming soon)
• Password protection for links. (Coming soon)
• Statistics for links. (Coming soon)
• Edit links. (Coming soon)
• RESTful API. (Coming soon)

Technologies

• Mongo DB (Database)
• Express (Web server framework)
• AngularJS (UI framework)
• NodeJS (Web server)

Setup

You need to have Node.js, Angular.JS and MongoDB installed on your machine.

1. Clone this repository or download zip.
2. Copy server/config.example.js to server/config.js and client/config.example.js to client/config.js.
3. Fill all the blank fields on those two files.
4. Install server dependencies: npm install.
5. Install client dependencies: cd client && npm install.
6. Run for development: npm start.
7. Run for production: npm run build then npm start.

API

API docs will be updated soon

Contributing

Feel free to contribute on this project and make pull requests.

Open issues for bug reports or feature requests.