Git Product home page Git Product logo

express-social-network's Introduction

express-social-network

This is a small social network REST API backend built with Node.js, Express.js, MongoDB and Mongoose, socket.io for realtime updates and mocha+chai for tests. It is a simple API that allows users to create accounts, create and interact with posts.

Auth is handled with JWT and password encryption with bcrypt.

Installation

  1. Clone the repo and run npm install to install all dependencies.

  2. Fill the .env file with following fields:

    MONGO_URL='mongodb://localhost:27017/posts'
    APP_PORT=3000
    IMAGE_FOLDER='images'
    JWT_TOKEN='secret'
    JWT_EXPIRES_IN='1h'
    
  3. Run npm start to start the server.

Usage

There are 2 main routes: /auth and /feed.

Auth:

  • /auth/signup - POST - Creates a new user account. Requires email, password and name fields in the request body.
  • /auth/login - POST - Logs in a user. Requires email and password fields in the request body.
  • /auth/status - GET - Returns the current user's status. Requires auth.
  • /auth/status - PATCH - Updates the current user's status. Requires auth.

Feed:

  • /feed/posts - GET - Returns all posts. Requires auth.
  • /feed/post - POST - Creates a new post. Requires title, content and image fields in the request body. Requires auth.
  • /feed/post/:postId - GET - Returns a single post. Requires auth.
  • /feed/post/:postId - PUT - Updates a single post. Requires title, content and image fields in the request body. Requires auth.
  • /feed/post/:postId - DELETE - Deletes a single post. Requires auth.

express-social-network's People

Contributors

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