Simple Blockchain

This project aims to complete the Udaciy Blockchain Nanodegree

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

Node V10.9.0+

brew install nvm
nvm install stable

Installing

A step by step to get up and running.

npm install
npm start

API Endpoint

The following endpoints are available:

Endpoints	Usage	Params
`GET /block/[blockHeight]`	Get the details of a block.
`GET /stars/address:[address]`	Add a new block.
`GET /stars/hash:[hash]`	Add a new block.
`POST /block`	Add a new block.	address - [String] star - [Object] - dec - [String] - ra - [String] - story - [String] - mag - [Number] - cons - [String]
`POST /requestValidation`	Add a new block.	address - [String]
`POST /message-signature/validate`	Add a new block.	address - [String] signature - [String]

Running the tests

This project make use of jest platform for unit tests. To run the tests, follow the instructions bellow:

npm test

Deployment

This project will use Docker container in the future.

Built With

Hapi - The web framework used
Jest - The test framework

Authors

Fernando Farias - Initial work - nandofarias

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Udacity Blockchain Nanodegree

nandofarias / simple-blockchain