Code Monkey home page Code Monkey logo

woozchucky / pau Goto Github PK

View Code? Open in Web Editor NEW
4.0 1.0 1.0 1.37 MB

GitHub repository for blockchain technology studying/examples/discoveries

License: MIT License

JavaScript 1.25% TypeScript 98.56% Dockerfile 0.19%
cryptocurrency blockchain blockchain-technology blockchain-demos blockchain-network blockchain-service blockchain-platform blockchain-wallet peer-to-peer peer-network decentralized decentralized-applications typescript nodejs http-server api-rest web-api localstorage cryptography

pau's Introduction

Welcome to the worst blockchain implementation ever seen

This sample code helps get you started with blockchain technology. Or at least should <.<

Status

Nodejs CI Docker Image Dependency Review Code Quality codecov

What's Here

This sample includes:

  • HTTP API
  • P2P Protocol
  • Wallet Concept
  • Nodes Discovery
  • Local Database
  • Cryptography
  • and last, but not least... awful code!

Getting Started

These directions assume you want to develop some sort of DApp (Decentralized Application) on your local computer, and not from wherever it is you want to host your nodes. (At least when starting)

To work on the sample code, you'll need to clone your project's repository to your local computer. If you haven't, do that first. You can find instructions @ Google and GitHub on how to clone a repository.

  1. Install Node.js on your computer. For details on available installers visit https://nodejs.org/en/download/.

  2. Install NPM dependencies:

     $ npm install
    
  3. Start the development node (starts a node names master):

     $ npm start
    
  4. Open http://127.0.0.1:3000/v1/status in a web browser to view your service details.

Development Scripts

  1. Start a single node

    $ npm start
    
  2. Start a single node watching for changes

     $ npm run start:watch
    
  3. Start a single node watching for changes and build to /dist folder

     $ npm run start:dev
    
  4. Build to /dist folder

     $ npm run build
    
  5. Run Linter

    $ npm run lint
    

Project Coverage

Coverage

What Do I Do Next?

Once you managed to keep your node running without it crashing in the first 5 minutes, look for the api routes, try to understand what they do, fail miserably and open an issue about the non existent documentation.

Now seriously, this is the most alpha project you will ever find on GitHub, i'm also still learning so don't expect to use this in any production environment. I plan to write some real documentation which should provide some help about where to start, but only after i feel this can actually be used by other developers.

In case you REALLY want to help me out in any way or have a problem, contact me at [email protected]

(When I have time I'll try to actually write a proper README, until then, good luck!)

LICENSE

All code here provided is under MIT license.

pau's People

Contributors

dependabot[bot] avatar snyk-bot avatar woozchucky avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

memazouni

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.