Skip to content

Commit

Permalink
readme in contract-and-js
Browse files Browse the repository at this point in the history
  • Loading branch information
Arthur-Kamau committed Aug 30, 2024
1 parent f673e99 commit 40ed7e0
Showing 1 changed file with 12 additions and 34 deletions.
46 changes: 12 additions & 34 deletions contract-and-js/web-app/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,12 @@
## Usage

Those templates dependencies are maintained via [pnpm](https://pnpm.io) via `pnpm up -Lri`.

This is the reason you see a `pnpm-lock.yaml`. That being said, any package manager will work. This file can be safely be removed once you clone a template.

```bash
$ npm install # or pnpm install or yarn install
```

### Learn more on the [Solid Website](https://solidjs.com) and come chat with us on our [Discord](https://discord.com/invite/solidjs)

## Available Scripts

In the project directory, you can run:

### `npm run dev` or `npm start`

Runs the app in the development mode.<br>
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.<br>

### `npm run build`

Builds the app for production to the `dist` folder.<br>
It correctly bundles Solid in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.<br>
Your app is ready to be deployed!

## Deployment

You can deploy the `dist` folder to any static host provider (netlify, surge, now, etc.)
## pre requisites
1. scarb.
2. vite, node and npm
3. starknet-devnet

## steps
1. run `starknet-devnet` in your os
2. run scarb build in `contract-and-js` folder.
3. use `https://stark-deployer.vercel.app/` to deploy the smart contract and get the smart contract account address.
4. update the const `contractAddress` in `app.tsx`
5. update the `account0Address` and `privateKey0` in `app.tsx`
6. npm run dev in `web-app`

0 comments on commit 40ed7e0

Please sign in to comment.