Skip to content

Update README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Hemachandra9899 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 29 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,40 +1,44 @@
# tools.simpleweb3.ch
# tools.simpleweb3.ch

## To Run
> A retro-themed Web3 developer tool for submitting Ethereum transactions with ease. Designed with a pixel UI, powered by Framer Motion, Wagmi, and WalletConnect.

### Pre-Requisites
> 1. Nodejs version 20+
---

### Installation
## 📌 Overview

```bash
npm install
```
This project helps developers simulate and submit Ethereum transactions in a pixelated interface.

### Have a environment variable
```bash
mv .env.example .env
# DONT FORGET TO UPDATE ENVIRONMENT VARIABLE
# FETCH THE PROJECT ID FROM https://cloud.walletconnect.com/
```
- Supports **EVM-compatible transactions**
- Includes **gas estimations**, **transaction types**, and **wallet integrations**
- Designed with **retro pixel UI** and **fluid animations**
- Built using **React + Tailwind + Wagmi**

### Start the website for development
---

```bash
npm run dev
```
## Dependencies

### Start the website for production(Two Steps)
Install all the required packages with:

first build
```bash
npm run build
npm install react react-dom react-router-dom
npm install tailwindcss postcss autoprefixer
npm install framer-motion
npm install pixel-retroui@latest
npm install wagmi viem
npm install vite
npm install @vitejs/plugin-react --save-dev
Copy link
Copy Markdown
Owner

@tejareddy8888 tejareddy8888 Jul 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have to install these packages individually? All the packages are already in package.json.

So only npm install should be sufficient

Copy link
Copy Markdown
Contributor Author

@Hemachandra9899 Hemachandra9899 Jul 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pixel-retroui@latest
this is from external sources so it might be not present in the npm install .

Copy link
Copy Markdown
Contributor Author

@Hemachandra9899 Hemachandra9899 Jul 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and they won't make any duplicates right?

Copy link
Copy Markdown
Owner

@tejareddy8888 tejareddy8888 Jul 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whenever we run, npm install <package≥, this package is added in package.json and package-lock.json. Unless you use npm install -g <package.json> where -g refers global

```

then preview
## Install all dependencies
```bash
npm run preview
npm install
```

## Development Mode
```bash
npm run dev
```
## Production Mode
```bash
npm run build
npm run preview
```