chore(scripts,docs): make submodule bootstrap explicit, drop auto-install on start
This commit is contained in:
30
README.md
30
README.md
@@ -71,29 +71,39 @@ You can also replace it with your own Alchemy Keys if you have one.
|
||||
|
||||
The application can be tested by its trial version [https://p2pix-staging.vercel.app/](https://p2pix-staging.vercel.app/), the only requirement is to be running the smart contract of local way. To run the application locally, there are two different ways:
|
||||
|
||||
### Run with yarn
|
||||
### Run with bun
|
||||
|
||||
```sh
|
||||
# Clone the repo
|
||||
git clone https://github.com/liftlearning/P2Pix-Front-End
|
||||
# Clone the repo WITH submodules (smart contracts live in p2pix-smart-contracts/)
|
||||
git clone --recurse-submodules https://github.com/liftlearning/P2Pix-Front-End
|
||||
cd P2Pix-Front-End
|
||||
|
||||
# Install dependencies with yarn
|
||||
yarn install
|
||||
# (If you cloned without --recurse-submodules, run this once)
|
||||
git submodule update --init --recursive
|
||||
|
||||
# Install front-end dependencies
|
||||
bun install
|
||||
|
||||
# One-time bootstrap of the smart-contracts submodule (needed before wagmi:gen)
|
||||
cd p2pix-smart-contracts && bun install && cd ..
|
||||
|
||||
# Generate ABI bindings from the submodule (run again whenever contracts change)
|
||||
bun run wagmi:gen
|
||||
|
||||
# Type-Check, Compile and Minify for Production
|
||||
yarn build
|
||||
bun run build
|
||||
|
||||
# Compile and Hot-Reload for Development (port 3000)
|
||||
yarn start
|
||||
bun start
|
||||
|
||||
# Lint with [ESLint](https://eslint.org/)
|
||||
yarn lint
|
||||
bun run lint
|
||||
```
|
||||
### Run with docker-compose
|
||||
|
||||
```sh
|
||||
# Clone the repo
|
||||
git clone https://github.com/liftlearning/P2Pix-Front-End
|
||||
# Clone the repo WITH submodules
|
||||
git clone --recurse-submodules https://github.com/liftlearning/P2Pix-Front-End
|
||||
cd P2Pix-Front-End
|
||||
|
||||
#1. Install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/);
|
||||
|
||||
@@ -3,7 +3,7 @@
|
||||
"version": "1.2.0",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"start": "bun run wagmi:gen && vite --host=0.0.0.0 --port 3000",
|
||||
"start": "vite --host=0.0.0.0 --port 3000",
|
||||
"build": "bun run type-check && bun run build-only",
|
||||
"build-only": "vite build",
|
||||
"preview": "vite preview",
|
||||
@@ -12,7 +12,7 @@
|
||||
"lint:fix": "eslint . --fix",
|
||||
"format": "prettier --write \"src/**/*.{ts,vue,json}\"",
|
||||
"format:check": "prettier --check \"src/**/*.{ts,vue,json}\"",
|
||||
"wagmi:gen": "pushd p2pix-smart-contracts && bun install && popd && wagmi generate"
|
||||
"wagmi:gen": "wagmi generate"
|
||||
},
|
||||
"dependencies": {
|
||||
"@floating-ui/vue": "^1.1.11",
|
||||
|
||||
Reference in New Issue
Block a user