Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ankushkun/esuraksha-cu
https://github.com/ankushkun/esuraksha-cu
Last synced: 6 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ankushkun/esuraksha-cu
- Owner: ankushKun
- Created: 2023-11-18T17:04:55.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-20T04:06:50.000Z (about 1 year ago)
- Last Synced: 2024-04-14T01:55:30.274Z (9 months ago)
- Language: TypeScript
- Homepage: https://fusionforces.vercel.app
- Size: 3.46 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blockchain Based E-Vault
Submission for the E-Suraksha hackathon at CU
- [Blockchain Based E-Vault](#blockchain-based-e-vault)
- [Team members](#team-members)
- [Tech Stack](#tech-stack)
- [How to run](#how-to-run)
- [Fork and Clone the repo](#fork-and-clone-the-repo)
- [Run the frontend](#run-the-frontend)
- [Run the backend](#run-the-backend)
- [Blockchain](#blockchain)
- [Run a local arweave node](#run-a-local-arweave-node)
- [Deploy the smart contract](#deploy-the-smart-contract)
- [Tests for the contract](#tests-for-the-contract)
## Team members
- [Ankush Singh](github.com/ankushKun)
- [Ashutosh Mittal](github.com/Aashu1412)
- [Prayrit](github.com/Prayrit9)
- Parth Tiwari
- Abhijeet Singh
## Tech Stack
- React
- Vite
- Arweave Blockchain
- Arweave.app web wallet
- arweavekit
# How to run
## Fork and Clone the repo
```bash
git clone https://github.com//esuraksha-cu.git
```
The project is split into 3 folders
- `app` - React frontend
- `instabase` - Express backend with instabase functions
- `contracts` - Arewave Smart contracts to store document data
### Run the frontend
```bash
cd app
npm install --force
```
```bash
npm run dev
```
### Run the backend
```bash
cd instabase
npm install --force
```
```bash
nodemon index.js
```
### Blockchain
#### Run a local arweave node
```bash
npx arlocal
```
#### Deploy the smart contract
```bash
cd contracts
npm install --force
```
**Smart Contract is in `contracts/contract.js`**
```bash
node deploy.js
```
#### Tests for the contract
```bash
node write.js
```
```bash
node read.js
```
**NOTE: All of these should be run with arlocal running in the background or in a terminal tab**
To make sure the contract deploys you will need an arweave `wallet.json` file which can be created using `ardrive-cli` or downloaded from arweave.app web wallet