-
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
64 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# pi-nexus-blockchain | ||
|
||
PI Nexus Blockchain API | ||
===================== | ||
|
||
This is a Node.js API for interacting with the PI Nexus blockchain. | ||
|
||
Getting Started | ||
--------------- | ||
|
||
### Installation | ||
|
||
1. Clone the repository: `git clone https://github.com/KOSASIH/pi-nexus-autonomous-banking-network.git` | ||
2. Install dependencies: `npm install` | ||
3. Start the API: `npm start` | ||
|
||
### Testing | ||
|
||
1. Run tests: `npm test` | ||
|
||
API Endpoints | ||
------------- | ||
|
||
### Nexus | ||
|
||
* `GET /nexus/:address`: Get a nexus by address | ||
* `POST /nexus`: Create a new nexus | ||
|
||
### Blockchain | ||
|
||
* `GET /blockchain/:networkId`: Get a blockchain by network ID | ||
* `POST /blockchain`: Create a new blockchain | ||
|
||
### Contracts | ||
|
||
* `GET /contracts/nexus`: Get the Nexus contract | ||
* `POST /contracts/nexus`: Deploy the Nexus contract | ||
|
||
License | ||
------- | ||
|
||
This project is licensed under the MIT License. | ||
|
||
Contributing | ||
------------ | ||
|
||
Contributions are welcome! Please open a pull request to contribute to the project. | ||
|
||
Authors | ||
------- | ||
|
||
* KOSASIH | ||
|
||
GitHub Features | ||
--------------- | ||
|
||
* [Actions](https://github.com/features/actions) | ||
* [Packages](https://github.com/features/packages) | ||
* [Security](https://github.com/features/security) | ||
* [Codespaces](https://github.com/features/codespaces) | ||
* [GitHub Copilot](https://github.com/features/copilot) | ||
* [Code review](https://github.com/features/code-review) | ||
* [Issues](https://github.com/features/issues) | ||
* [Discussions](https://github.com/features/discussions) |