Piefy - URL Shortener

Piefy is a URL Shortener made with Node.js and PostgreSQL. This was created as a personal project to learn how a URL shortening service works.

Note: Since this was intended as a personal project, the shortened url generated is not exactly "short". The project is hosted only for free in Vercel, so the domain name is a default one.

Usage

1. Paste or enter the original link you want to shorten.
2. Click the "Slice Away!" button to shorten it.
3. Wait for the process to finish.
4. Once the link is generated, click the "Copy" button to copy the shortened URL.
5. Use the link to your heart's content and enjoy! :)

Installation

1. Clone the repository to your directory.

git clone https://github.com/jazellecruz/piefy.git

2. Navigate to the directory the repository is located.
3. Install all the dependencies needed for the project.

npm install

4. Configure the source code if you want. (database URI, port, etc.)
5. Run the application.

node server.js

or

nodemon

Note: Nodemon is installed as a dependency.

6. Open the web app locally from your browser on port 8000 (or on your configured port).

http://localhost:8000

7. Enjoy!

Contributing

Any contribution is welcome. Just kindly make a pull request. For major changes, please open an issue first to discuss what you would like to change.

Links

piefy.vercel.app - live demo of the web app.

jazzcruz.vercel.app - developer's personal website.