Giter VIP home page Giter VIP logo

venomgram-server's Introduction

venomgram-server

REST API built with Node/Express/MongoDB. Serves as the back-end for Venomgram, an Instagram clone built with full-stack JavaScript. The UI was built with Vue, check that out here.

Instructions

It's actually very easy to get your own copy of venomgram-server running using Heroku.

  1. Fork this repository and create a Node.js Heroku dyno that is deployed via your new venomgram-server repository.

  2. Install the Cloudinary and mLab add-ons to your Heroku dyno. This automatically creates two of the environmental variables you need.

  3. Head to the settings for your dyno and configure the remaining environmental variables you need: JWT_KEY (the secret key your app will use to sign JSON web tokens) and UI_URL (enabling CORS for the domain you will use for your UI).

And voila! You have your own copy of venomgram-server running, complete with persistent data storage and a remote MongoDB database.

API

Endpoint JWT Variables Method
/post/feed/:username/:from/:to X None [1] GET
/post/explore/:username/:from/:to X None [1] GET
/post/profile/:username/:from/:to X None [1] GET
/post/upload file POST
/post/delete id DELETE
/post/like id PATCH
/post/unlike id PATCH
/post/report id PATCH
/user/user X None [1] GET
/user/self None [2] GET
/user/register X username, password POST
/user/login X username, password POST
/user/update file [3], bio PATCH
/user/delete None [2] DELETE
/user/follow username PATCH
/user/unfollow username PATCH
/user/block username PATCH
/user/unblock username PATCH
  1. Operate entirely on endpoint params.
  2. Operate entirely on JSON web token.
  3. Optional. Will only update bio if not sent.

venomgram-server's People

Contributors

ibrahimpg 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.