Skip to content

Commit

Permalink
Merge pull request #82 from Scaffold-Stark/fix/miscellaneous-fixes
Browse files Browse the repository at this point in the history
fix: miscellaneous fixes
  • Loading branch information
metalboyrick authored Jan 10, 2025
2 parents 4c8b7c4 + b5b7674 commit 5bd4d94
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 13 deletions.
23 changes: 13 additions & 10 deletions docs/deploying/deploy-production.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ Before deploying to production, ensure you have the correct versions of all depe

```bash
# Check versions
node --version # >= v18.17
starknet-devnet --version # 0.2.3
scarb --version # 2.9.2
snforge --version # 0.34.0
node --version # >= v18.17
starknet-devnet --version # 0.2.3
scarb --version # 2.9.2
snforge --version # 0.34.0
```

:::warning
Expand All @@ -35,7 +35,9 @@ Delete the debug page and its components:
rm -rf packages/nextjs/app/debug
```

#### 2. Remove the debug route from your navigation if you've added it manually in any of your components.
#### 2. Remove the debug route from your navigation

If you've added it manually in any of your components, you can remove the debug route from it.

:::tip Hint
If you want to keep the debug features for development while removing them from production, you can use environment-based conditional rendering:
Expand Down Expand Up @@ -106,13 +108,14 @@ eslint: {
These settings control how your application handles TypeScript and ESLint errors during the build process:
- When NEXT_PUBLIC_IGNORE_BUILD_ERROR is set to "true":
- When `NEXT_PUBLIC_IGNORE_BUILD_ERROR` environment variable is set to `true`:
- TypeScript type checking errors won't stop your build
- ESLint warnings and errors won't prevent deployment
- This is useful when: - You're in rapid development and want to test deployments despite minor type issues - You're dealing with third-party dependencies that have type conflicts - You're migrating a JavaScript project to TypeScript and want to deploy while still fixing type issues
:::warning
While these settings can help you deploy quickly, it's recommended to fix all TypeScript and ESLint errors before deploying to production. Ignoring these errors might hide potential bugs or issues in your code.
:::warning
:::warning
While these settings can help you deploy quickly, it's recommended to fix all TypeScript and ESLint errors before deploying to production. Ignoring these errors might hide potential bugs or issues in your code.
:::warning
#### 2. Webpack optimization for compatibility:
Expand Down Expand Up @@ -227,7 +230,7 @@ const nextConfig = {
## 6. Production Deployment Checklist
Before deploying to production, ensure you have:
Before deploying to production, you can follow the following checklist to make sure you have the most optimum build:
- [ ] Removed or conditionally rendered debug packages
- [ ] Configured production environment variables
Expand Down
2 changes: 1 addition & 1 deletion docs/eth-stark/eth-stark.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 6
---

# 🚩 (Coming Soon) Using Scaffold Stark with Ethereum Contracts
# 🚩 Using Scaffold Stark with Ethereum Contracts

[Scaffold-ETH-Stark](https://github.com/Scaffold-Stark/scaffold-eth-stark) is an innovative toolkit that combines the capabilities of Scaffold-Stark and Scaffold-ETH, providing a unified solution for building decentralized applications (dapps) on both Starknet and EVM-compatible blockchains.

Expand Down
4 changes: 2 additions & 2 deletions docs/quick-start/starknet-devnet-with-asdf.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Starknet Devnet - Installation with asdf
# Setting up `starknet-devnet` with `asdf`

This document provides a guide to install **Starknet Devnet** using `asdf`, a Rust-based tool for developers. Below, you'll find instructions for installation using `asdf`.
This document provides a guide to install **Starknet Devnet** using `asdf`, a Rust-based tool for developers. Below, you'll find instructions for installation using `asdf`. This method is preferred since it will be easier to stay tune to updates and sync in case there are major changes.

## Requirements

Expand Down

0 comments on commit 5bd4d94

Please sign in to comment.