Giter Club home page Giter Club logo

enigma's Introduction

Enigma

Javascript module for implementing AES Cryptography algorithum on data transferred via GraphQL & REST API

About the project

It’s no secret that “Data is the new oil”. We all visit hundreds of websites daily and we share and create huge amounts of data every single day on those websites. Many of those websites aren’t secure in terms of user privacy and data protection. Several organizations use insecure connections to transfer data over their intranet, which is a major vulnerability.

Our aim is to secure the transfer of data over insecure channels.

Project Structure

Our project has the following structure:

  • docs
  • node_modules
  • src
    • config
    • controllers
    • graphql
    • middleware
    • models
    • routes
    • utils

1. Docs

This contains all the markdown files for the documentation of the project, which is visualized on Docsify.

2. Node Modules

Contains project dependencies.

3. Config

This contains all the configuration files; like database connectivity, winston setup, etc.

4. Controllers

This contains all the REST API end-points.

5. GraphQL

This contains schema files, queries and mutations for GraphQL API.

6. Middleware

This contains all the middleware functions of the request-response pipeline.

7. Models

This contains all the mongoDB schema.

8. Routes

This contains all the routes for REST API.

9. Utils

This contains all the helper functions associated with other endpoints.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

Following are the softwares requried to get arena up and running.

Installing

  • Install the packages mentioned in package.json file for getting all dependencies of the project.

    npm install --save
    
  • Getting the configuration ready

    cp .env.example .env
    
  • Starting the application

    npm run dev
    
  • Setting the pre-push hook

    ./hooks.sh
    

Linting the Code

  • For linting the code
npm run lint -s
  • For fixing the linting mistakes in code
npm run fix -s

Issues

Issues are managed via GitHub Issues here.

Developers

License

This project is licensed under the Apache License. See the LICENSE.md file for details.

enigma's People

Contributors

ac030540 avatar adityap301 avatar dependabot[bot] avatar swap76 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

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