Skip to content

Commit

Permalink
update readme and add more sample data for dev
Browse files Browse the repository at this point in the history
  • Loading branch information
dalindev committed Sep 23, 2024
1 parent 7c513d9 commit 71498a4
Show file tree
Hide file tree
Showing 7 changed files with 1,212 additions and 118 deletions.
3 changes: 2 additions & 1 deletion .env.local.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Private variables

# Public variables
NEXT_PUBLIC_USE_SAMPLE_DATA=true # Set to true to use sample data for development
NEXT_PUBLIC_USE_SAMPLE_DATA=true # Set to true to use sample data for development
NEXT_PUBLIC_WS_URL=[Nano Websocket URL]
57 changes: 26 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,46 +14,41 @@ https://github.com/user-attachments/assets/fdd6f818-8279-4f0f-9d59-22bf28de70d7

## Overview

This PR serves as the initial merge from the `dev` branch to the `main` branch. It introduces a globe visualization of the Nano currency network, built using Next.js, Three.js, and React. The application is deployed on Vercel.
Nano Network Globe Visualization is a web application that allows you to visualize the Nano network on a globe. It uses a custom websocket client to connect to the Nano network and receive real-time data. The data is then visualized on a globe using a custom 3D globe library.

## Table of Contents
## Prerequisites

- [Features](#features)
- [Technologies](#technologies)
- [Collaboration with AI](#collaboration-with-ai)
- [Related Issues](#related-issues)
- [Next Steps](#next-steps)
- [Deployment](#deployment)
Before running the application, make sure you have pnpm installed. If you don't have pnpm, you can install it using npm:
```bash
npm install -g pnpm
```

## Features
## Setup

### Included:
Before running the application, you need to set up your environment variables:

- Globe representation of Earth
- Day and night effects
- Moving clouds
- Stars background for the universe
- Live nano network confirmations
1. Copy the `.env.local.example` file and rename it to `.env.local`:
2. Open the `.env.local` file and update the variables:
- `NEXT_PUBLIC_USE_SAMPLE_DATA`: Set to `true` to use sample data for development, or `false` to use live data.
- `NEXT_PUBLIC_WS_URL`: Set this to the Nano Websocket URL you want to connect to.

## Technologies
Example `.env.local` file:
```
NEXT_PUBLIC_USE_SAMPLE_DATA=false
NEXT_PUBLIC_WS_URL=wss://example-nano-node.com/ws
```

- [ChatGPT 4](https://chat.openai.com)
- [Next.js](https://nextjs.org/)
- [Three.js](https://threejs.org/)
- [React](https://reactjs.org/)
- [Vercel](https://vercel.com/)
## How to run

## Collaboration with AI
1. Clone the repository
2. Run `pnpm install`
3. Run `pnpm dev`

All code, including bug fixes, error handling, and refactoring, was generated by ChatGPT-4 under my instruction. This project serves as an exploration into leveraging AI technologies like ChatGPT to improve productivity.
## Production

## Next Steps
1. Run `pnpm build`
2. Run `pnpm start`

- Implement socket listeners for real-time network data
- Visualize Nano node locations
- Represent live votes and transactions with arcs

## Deployment

The application is deployed on [Vercel](https://vercel.com/). [Click here](#) to view the live demo.
## License

This project is licensed under the MIT License. See the LICENSE file for more details.
16 changes: 5 additions & 11 deletions constants/nano-live-env.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,11 @@
export const NANO_LIVE_ENV = {
production: true,
network: 'live',
// wsUrl: 'wss://node.somenano.com/websocket',
// wsUrl: 'wss://rainstorm.city/websocket',
// wsUrl: 'wss://bitrequest.app:8010/websocket',
wsUrl: 'wss://nanoslo.0x.no/websocket',
// wsUrl: 'ws://localhost:8080/websocket',

// wsUrl: 'wss://node.somenano.com/repeater',
rpcUrl: 'https://nanoproxy.numsu.dev/proxy',
principalsUrl: 'https://nanobrowse.com/api/reps_online',
explorerUrl: 'https://nanolooker.com',
repInfoUrl: 'https://mynano.ninja',
wsUrl: process.env.NEXT_PUBLIC_WS_URL ?? '',
// rpcUrl: 'https://nanoproxy.numsu.dev/proxy',
// principalsUrl: 'https://nanobrowse.com/api/reps_online',
// explorerUrl: 'https://nanolooker.com',
// repInfoUrl: 'https://mynano.ninja',
donationAccount:
'nano_1osom16ctb773i6zi5fnepfro7bcmr5yqxb4qnmtzxkmdg88o4x6obmchzna'
};
Loading

0 comments on commit 71498a4

Please sign in to comment.