Brevis is a URL Shortening webapp created using Node.js Express.js, and Vue.js (Nuxt.js). The name "brevis" is the Latin term for "short", which represents the functionality of a URL "short"ening webapp after all!
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
brevis-api
brevis-client
.gitignore
LICENSE
README.md

README.md

Brevis - The Modern URL Shortener Webapp

Developed by Eric Liang

Brevis is a URL Shortening webapp created using NodeJS, ExpressJS, and NuxtJS (MEVN stack). The name "brevis" is the Latin term for "short", which represents the functionality of a URL "short"ening webapp after all!

NOTE:

  • This is NOT made with Bitly API or any URL Shortening APIs from any URL Shortening Sites.
  • I made this for the sake of fun and practice. I didn't focus too much on security of the webapp, so use at your own risk if you plan to release this into a production environment. You are responsible for anything that happens.

Demo : https://brevisapp.herokuapp.com

Brevis Website Screenshot

Getting Started

Requirements

  • Node.js

Knowledge/Understanding

  • HTML/CSS/JS - Language
  • Vue.js (Nuxt.js) - Frontend Framework
  • Node.js - Backend Framework
  • Express.js - Backend Framework
  • Mocha.js/Chai.js - Backend Testing

Deployment

  1. Make sure you have the necessary tools installed on your machine to run Node.js, Nuxt.js, and Express.js applications.
  2. Run "npm install"
  • inside folder brevis-api
  • inside folder brevis-client
  1. Start the API backend in brevis-api folder by running "npm start".
  2. Next start the API frontend in brevis-client folder by running "npm run dev" if you're on a development machine.
  3. Enjoy! :)

Testing

Assuming you just downloaded the project and extracted it from the .zip folder.

  1. Run "npm install" in the api folder.
  2. Run "npm test" to run the tests created.

All tests are contained in the /brevis-api/test folder.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details