Giter Club home page Giter Club logo

szprio-api's Introduction

Backend server for szpr.io

๐Ÿ› ๏ธ Get Started

  1. Install the node packages
$ npm install
  1. Run the server process
$ npm start

๐Ÿ—‚๏ธ Project Directory Structure

  • Server
    • bin
    • configs
    • v1
      • controllers
      • models
      • routes

๐Ÿชง Endpoint Routes

Route HTTP Method Description
v1/link/:nanoId GET Redirects to a link
v1/link POST Creates a new link document

๐Ÿ“ Schemas

Users Collection

{
	"_id": "ObjectId",
	"name": {
		"first": "String",
		"last": "String",
		"user": "String"
	},
	"paid": "Boolean"
}

Links Collection

{
	"_id": "ObjectId",
	"analytics": {
		"clicks": "Number"
	},
	"date": {
		"createdAt": "Date",
		"updatedAt": "Date"
	},
	"link": "String",
	"nanoId": "String",
	"user": "String",
	"title": "String"
}

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.