Reconcile README feature status with the shipped Testnet integration

Open Beginner friendly
#55 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
typescript
Domain
documentation

Research direction

Read README.md alongside docs/FRONTEND_SETUP.md, next.config.ts, the proxy route, and the backend README, config, and deployment evidence. Verify the deployment, contract, network gate, API proxy, and feature claims against those sources; date live observations and preserve Soroswap attribution. Update the status table and setup guidance to meet each acceptance criterion, then check links and code examples.

Written by the indexing model from the issue text.

Description

documentation good first issue

Problem

README.md still describes no completed Testnet deployment and an overridable Mainnet release gate, while the backend records Factory/Router deployment evidence and the frontend refuses Mainnet configuration. It also describes client-side API configuration although the shipped app now uses a same-origin proxy. Related historical issues: #10, #11, #12, #15 and #17.

Scope

Update the frontend status table and setup/deployment guidance from current source and backend evidence. This is documentation work; do not implement missing trading features or change network gates.

Acceptance criteria

  • Distinguish a deployed web app, verified AMM contracts, a missing separate aggregator, empty liquidity and actual end-to-end swap verification.
  • Document server-side VELTRIXAE_API_URL, its compatibility fallback and local backend port 3100 consistently with docs/FRONTEND_SETUP.md.
  • Describe Mainnet as unsupported; remove statements suggesting a release flag can enable it.
  • Separate implemented UI/schema support from available backend analytics, portfolio history, liquidity preparation and additional wallet integrations.
  • Link deployment/provenance claims to repository evidence and date any live observations.
  • Preserve Soroswap attribution and distinguish VELTRIXAE changes from upstream functionality.

Contributor guidance

Estimated difficulty: small; suitable as a first documentation contribution. Inspect README.md, next.config.ts, the proxy route and backend README/config/evidence. Check links and code examples. If a behavior cannot be verified, label it unavailable or not verified instead of claiming completion.

Dominant language
TypeScript
Stars
0
Forks
3
Avg merge
19h 38m
Merged PRs (30d)
36

Getting set up

Open in Codespaces

Starts the project's dev container in your browser, under your own GitHub account.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from VELTRIXAE/frontend

All issues in VELTRIXAE/frontend

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.