Skip to content

Commit

Permalink
docs: update README and PR template (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
derianrddev authored Dec 7, 2024
1 parent 68f6875 commit 3962365
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 19 deletions.
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@
## ✅ Changes made
-

## 🖼️ Media (screenshots/videos)
-

## 📜 Additional Notes
-
26 changes: 7 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,26 +41,20 @@ Welcome to the **Web Marketplace with Escrow Contracts**, a decentralized platfo

1. **Clone the Repository**:
```bash
git clone https://github.com/yourusername/marketplace-escrow-stellar.git
cd marketplace-escrow-stellar
git clone https://github.com/your-username/SafeSwap.git
cd SafeSwap
```

2. **Install Dependencies**:
```bash
npm install
```

3. **Configure Environment Variables**:
- Create a `.env` file in the root directory and add your Stellar and Trustless Work API keys:
```plaintext
STELLAR_SECRET_KEY=your_stellar_secret_key
TRUSTLESS_API_KEY=your_trustless_work_api_key
```
4. **Start the Application**:
```bash
npm start
```
Available Commands:
- `npm run web:dev` - Start development server
- `npm run web:build` - Create production build
- `npm run web:start` - Start production server
- `npm run web:lint` - Run Biome linter

### Frontend

Expand All @@ -81,12 +75,6 @@ Welcome to the **Web Marketplace with Escrow Contracts**, a decentralized platfo

4. Open [http://localhost:3000](http://localhost:3000) in your browser

Available Commands:
- `npm run web:dev` - Start development server
- `npm run web:build` - Create production build
- `npm run web:start` - Start production server
- `npm run web:lint` - Run Biome linter

## 📚 Documentation

For detailed frontend documentation, see the [README.md](frontend/README.md) file.
Expand Down

0 comments on commit 3962365

Please sign in to comment.