GithubHelp home page GithubHelp logo

snip-server's Introduction

Snip - A url shortener application

SNIP is a backend server for a URL shortener application. It's built using Express.js and Node.js, with MongoDB as the NoSQL database. Users can submit a title and URL to create short links. Hosted on Railway.

Snip frontend Repo ↗

Tech Stack

Client: Next.js, TailwindCSS

Server: Node.js, Express.js

Database: MongoDB

Highlight: Used SSR, CSR, NextAuth (Google)

API Reference

Create a url

  POST /url
Body Type Description
title string Required. A title related to url
url string Required. Url

Created short url

  GET /url/:shortId
Parameter Type Description
shortId string Required. short id created after Post

Get analytics (how many vist on shorten url)

  GET /url/analytics/:shortId
Parameter Type Description
shortId string Required. short id created after Post

Get all url created by a user

  GET /url/all-urls/:id
Parameter Type Description
:id string Required. Id of logged in user

Run Locally

Clone the project

  git clone https://github.com/aakashvani/snip-server.git

Install dependencies

  npm install

Start the server

  npm run start

snip-server's People

Contributors

aakashvani avatar

Watchers

avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.