From 396236513fd1860f7b62b675143c5f4e8f18038e Mon Sep 17 00:00:00 2001 From: Derian <59376626+derianrddev@users.noreply.github.com> Date: Sat, 7 Dec 2024 10:44:06 -0600 Subject: [PATCH] docs: update README and PR template (#43) --- .github/PULL_REQUEST_TEMPLATE.md | 3 +++ README.md | 26 +++++++------------------- 2 files changed, 10 insertions(+), 19 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 62ab398..aca485e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -9,5 +9,8 @@ ## ✅ Changes made - +## 🖼️ Media (screenshots/videos) +- + ## 📜 Additional Notes - diff --git a/README.md b/README.md index 4d5164b..05b5768 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,8 @@ 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**: @@ -50,17 +50,11 @@ Welcome to the **Web Marketplace with Escrow Contracts**, a decentralized platfo 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 @@ -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.