Skip to content

Commit

Permalink
edited README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
iskysun96 committed Oct 24, 2023
1 parent 4f6eada commit 5810dfd
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 9 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# charity-crowdfunding-tealscript

This starter full stack project has been generated using AlgoKit. See below for default getting started instructions.
This is a fullstack charity crowdfunding application built with AlgoKit, the fullstack template, and TEALScript for the smart contract. See below for getting started instructions.

## Setup

Expand All @@ -20,20 +20,36 @@ This starter full stack project has been generated using AlgoKit. See below for

# Demo

Make sure you are in workspace mode for vscode. You can do this by going to the `charity-crowdfunding-algokit.code-workspace` file and clicking on the `workspace` button on the bottom right of the screen. This will open up the workspace in vscode.
Make sure you are in workspace mode for vscode. You can do this by going to the `charity-crowdfunding-tealscript.code-workspace` file and clicking on the `workspace` button on the bottom right of the screen. This will open up the workspace in vscode.

Before you continue make sure you have Docker Desktop running in the background. We use Docker to launch a local Algorand blockchain on your computer.

## Backend
Make sure you are in the `Backend` folder in your terminal.

The `deploy-config.ts` file in `backend/smart_contracts/charity_crowdfunding` folder contains a test script that goes through the entire lifecycle of a charity crowdfunding app. You can run this script by running the following command in the terminal:

```
cd backend
hit F5
cd smart_contracts/charity_crowdfunding
npx tealscript contract.algo.ts ../artifacts/charity_crowdfunding_app
algokit generate client ../artifacts/charity_crowdfunding_app -o ../artifacts/charity_crowdfunding_app/client.ts -l typescript
```

Then go to "RUN AND DEBUG" in VSCode and Run `Deploy Built TEALScript application`


## Frontend
Make sure you are in the `frontend` folder in your terminal.

To launch a local server to play around with the frontend:

```
npm run build
npm run preview
```

Running these two commands will launch a local server with the frontend running on it.

TODO

### Subsequently

Expand Down
2 changes: 1 addition & 1 deletion backend/.vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"envFile": "${workspaceFolder}/.env.localnet"
},
{
"name": "Deploy Built Beaker application",
"name": "Deploy Built TEALScript application",
"type": "node",
"request": "launch",
"runtimeExecutable": "npm",
Expand Down
2 changes: 1 addition & 1 deletion charity-crowdfunding-tealscript.code-workspace
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
"name": "Run Frontend (+ LocalNet and Smart Contract)",
"configurations": [
{
"name": "Deploy Built Beaker application",
"name": "Deploy Built TEALScript application",
"folder": "backend"
},
{ "name": "Run dApp", "folder": "frontend" }
Expand Down
2 changes: 1 addition & 1 deletion frontend/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# frontend

This starter React project has been generated using AlgoKit. See below for default getting started instructions.
This React project has been generated using AlgoKit. See below for default getting started instructions.

# Setup

Expand Down
2 changes: 1 addition & 1 deletion frontend/src/components/CreateCharity.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ export function StartCreate({ onFormSubmit }: StartCreateComponentProps) {
onClick={handleSubmit}
disabled={loading}
>
{loading ? <span className="loading loading-spinner" /> : <p className="text-white">'Create Fundraiser'</p>}
{loading ? <span className="loading loading-spinner" /> : <p className="text-white">Create Fundraiser</p>}
</button>
</div>
</div>
Expand Down

0 comments on commit 5810dfd

Please sign in to comment.