Skip to content

docs: fix README typos and add .gitignore #13

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
corvid-agent wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix README typos and add .gitignore #13

Show file tree
Hide file tree
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
25 changes: 25 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Dependencies
node_modules/

# Environment variables
.env
.env.local
.env.*.local

# Build output
dist/
build/

# IDE
.vscode/
.idea/
*.swp
*.swo

# OS files
.DS_Store
Thumbs.db

# Logs
*.log
npm-debug.log*
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Use this template to kickstart your project, prototype ideas, and showcase a wor
To create your own copy of this repository:

a. **Go to the GitHub Repository:**
- Navigate to the main page which is the current one your on.
- Navigate to the main page which is the current one you're on.

b. **Click the "Fork" Button:**
- In the top-right corner of the page, click the **Fork** button. This will create a copy of the repository under your GitHub account. Feel free to hit the ⭐️ aswell so you can find the Algorand-dApp-Quick-Start-Template-Typescript repo easily!
- In the top-right corner of the page, click the **Fork** button. This will create a copy of the repository under your GitHub account. Feel free to hit the ⭐️ as well so you can find the Algorand-dApp-Quick-Start-Template-Typescript repo easily!

c. **Wait for the Forking Process to Complete:**
- GitHub will take a few moments to create the fork. Once complete, you’ll be redirected to your newly created fork.
Expand Down Expand Up @@ -80,7 +80,7 @@ This is the fastest way to get up and running!
> 💡 **Note:** You can stay in the **root directory** of the project when running the command.
> (This is usually the folder automatically opened when entering the Workspace, so you don’t need to move elsewhere.)

Once your `.env` files are ready (Expecially the Network one), run the command below to start the project:
Once your `.env` files are ready (especially the Network one), run the command below to start the project:

```bash
npm run dev
Expand Down Expand Up @@ -134,7 +134,7 @@ Below are videos on:
- How to use the Algo Dispenser
- How to use the USDC Dispenser

**How to connext to testnet on Pera Wallet**
**How to connect to testnet on Pera Wallet**

https://github.com/user-attachments/assets/31df8135-119e-4529-9539-4943de979719

Expand Down