Giter Club home page Giter Club logo

facebroke's Introduction

FaceBroke

A deliberately hackable social network app

Requirements

  • Docker
  • docker-compose

The best way to run FaceBroke is within Docker. Before continuing, make sure that you have Docker installed and can run it from the command line. If you're running Linux, you'll also need to manually install docker-compose

Running

  1. Clone this repo with: git clone https://github.com/softwaresecured/FaceBroke.git

  2. Go to the cloned directory: cd FaceBroke/

  3. run: docker-compose up --build -d

This will launch the FaceBroke project. You can view the web interface at http://127.0.0.1:8081 and the Postgresql server is exposed on port 5432 to the host environment.

Rebuilding

  1. While still in the project directory, run: docker-compose up --build -d

Stopping

  1. While still in the project directory, run: docker-compose down

UNDER DEVELOPMENT

Bug naming

Two branches of code exist here:

  • master --> for the working app.
  • vulnerable --> where intentional vulnerabilities have been introduced and tagged

In order to accurately track these 'bugs', we need a naming convention. Current idea is:

{filename}-{previous commit hash}-{starting line of bug}

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.