Skip to content

Commit

Permalink
Merge pull request djeck1432#429 from djeck1432/feat/documentation
Browse files Browse the repository at this point in the history
Spotnet documentation changes, small fixes in typo errors
  • Loading branch information
djeck1432 authored Dec 23, 2024
2 parents 97ae343 + e03e8bc commit 80b2741
Show file tree
Hide file tree
Showing 6 changed files with 218 additions and 19 deletions.
3 changes: 3 additions & 0 deletions frontend/src/App.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import { createPortal } from 'react-dom';
import { logout } from './services/wallet';
import { getTelegramUserWalletId } from './services/telegram';
import Documentation from './pages/documentation/Documentation';
import TermsAndConditions from './pages/terms-and-conditions/TermsAndConditions';

import Withdraw from './pages/withdraw/Withdraw';
import { useWalletStore } from './stores/useWalletStore';
import { Notifier, notify } from './components/layout/notifier/Notifier';
Expand Down Expand Up @@ -103,6 +105,7 @@ function App() {
<Route path="/overview" element={<OverviewPage />} />
<Route path="/form" element={<Form />} />
<Route path="/documentation" element={<Documentation />} />
<Route path="/terms-and-conditions" element={<TermsAndConditions />} />
<Route path="/stake" element={<Stake />} />
<Route path="/defispring" element={<DefiSpringPage />} />
</Routes>
Expand Down
71 changes: 56 additions & 15 deletions frontend/src/pages/documentation/Documentation.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,11 @@ const Documentation = () => {
link: '#overview',
subItems: [
{ id: 'cosmos-1', name: 'Cosmos Overview', link: '#cosmos-1' },
{ id: 'cosmos-2', name: 'Cosmos Overview', link: '#cosmos-2' },
{ id: 'cosmos-3', name: 'Cosmos Overview', link: '#cosmos-3' },
{ id: 'cosmos-4', name: 'Cosmos Overview', link: '#cosmos-4' },
],
},
{ id: 'how-it-performs', name: 'How it performs', link: '#how-it-performs' },
{ id: 'getting-started', name: 'Getting Started', link: '#getting-started' },
{ id: 'powered-by-starknet', name: 'Powered by Starknet', link: '#powered-by-starknet' },
{ id: 'getting-started', name: 'Getting Started: Setting up your wallet', link: '#getting-started' },
];

const sectionsData = [
Expand All @@ -34,18 +32,29 @@ const Documentation = () => {
{
type: 'text',
value:
'Welcome to spotnet Documentation \n Spotnet is a decentralized platform designed to [describe purpose, e.g., "empower users to securely manage digital assets and access DeFi tools effortlessly"]. \n This documentation provides a comprehensive guide on using SpotNet and making the most of its features.',
'Welcome to Spotnet documentation.',
},
{
type: 'text',
value:
'Spotnet is a decentralized platform designed to help users easily amplify their investments in digital assets like ETH. \n This documentation provides a comprehensive guide on using SpotNet and making the most of its features.',
},
],
},
{
id: 'overview',
title: 'Overview',
content: [

{
type: 'text',
value:
'What is Spotnet?',
},
{
type: 'text',
value:
'What is [Product Name]?\n[Product Name] is a Web3 platform that leverages blockchain technology to [describe primary functionalities, e.g., "facilitate secure transactions, staking, and asset management without intermediaries"].',
'Spotnet is a Web3 platform that leverages blockchain technology to facilitate secure transactions, staking, and asset management without intermediaries, enabling users to amplify their investments in digital assets through decentralized lending protocols and automated market makers (AMMs).',
},
{
type: 'text',
Expand All @@ -55,8 +64,8 @@ const Documentation = () => {
type: 'list',
items: [
'Decentralized Finance (DeFi): Access a suite of DeFi services, including lending, borrowing, and yield farming.',
'Security-First Design: Built on smart contracts to ensure safety and transparency.',
'Cross-Chain Compatibility: [Product Name] supports multiple blockchains for a seamless user experience.',
'Security-First Design: Built on smart contracts to ensure safety, transparency, and user control over assets without intermediaries.',
'Cross-Chain Compatibility: Spotnet supports multiple blockchains, including Starknet, for a seamless and efficient user experience, providing more liquidity and flexibility across the DeFi ecosystem.',
],
},
],
Expand Down Expand Up @@ -106,7 +115,7 @@ const Documentation = () => {
},
{
id: 'zk-lend',
title: 'Zklend Overview - Powering Your DeFi Journey with Security and Simplicity',
title: 'Zklend Overview',
content: [
{
type: 'text',
Expand Down Expand Up @@ -151,20 +160,52 @@ const Documentation = () => {
},
{
id: 'getting-started',
title: 'Getting Started',
title: 'Getting Started: Setting Up Your Wallet',
content: [

{
type: 'text',
value: 'Setting Up Your Wallet',
value: 'To get started with Spotnet and fully leverage its features, you’ll need to set up a compatible Web3 wallet. Follow the steps below to set up your wallet and connect it to Spotnet:',
},

{
type: 'orderedList',
type: 'text',
value: 'Download a Compatible Web3 Wallet',
},
{
type: 'list',
items: [
'Download a compatible Web3 wallet (e.g., MetaMask).',
'Fund your wallet with the supported cryptocurrency.',
'Connect your wallet to [Product Name].',
'MetaMask: MetaMask is one of the most popular Web3 wallets that allows you to interact with decentralized applications (dApps) like Spotnet. You can download MetaMask as a browser extension for Chrome, Firefox, or Brave, or as a mobile app for iOS and Android.',
'Other Wallets: Spotnet supports multiple Web3 wallets. You may also choose other wallets like WalletConnect, Coinbase Wallet, or Trust Wallet, depending on your preferences and device compatibility.',
],
},

{
type: 'text',
value: 'Fund Your Wallet with Supported Cryptocurrency',
},

{
type: 'list',
items: [
'Once your wallet is installed, you need to fund it with supported cryptocurrencies such as ETH or stablecoins (e.g., USDC). You can transfer funds from a cryptocurrency exchange (like Coinbase, Binance, or Kraken) by withdrawing them to your wallet address. Alternatively, you can purchase cryptocurrency directly within the wallet using third-party services or transfer assets between blockchains using a bridge.',
],
},

{
type: 'text',
value: 'Connect Your Wallet to Spotnet',
},
{
type: 'list',
items: [
"After funding your wallet, go to the Spotnet platform and look for the “Connect Wallet” button, typically found in the top-right corner of the homepage. Select your wallet type (e.g., MetaMask, WalletConnect) and follow the prompts to authorize the connection. Your wallet will ask for permission to connect with Spotnet; confirm this request to allow your wallet to interact with the platform. If you’re using a wallet like MetaMask that doesn’t support Starknet by default, you may need to manually add the Starknet network by selecting “Custom RPC” in your wallet settings and entering the necessary network details. Once connected, you'll have full access to Spotnet’s features.",
],
},




],
},
];
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/pages/overview/Overview.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const OverviewPage = () => {
{
type: 'text',
value:
'Welcome to [Product Name], the decentralized platform designed to empower you with seamless access to the Web3 ecosystem. Built on blockchain technology, [Product Name] provides a secure, transparent, and user-friendly experience for managing your digital assets, accessing decentralized finance (DeFi) services, and engaging with the broader Web3 community.',
'Welcome to Spotnet, the decentralized platform designed to empower you with seamless access to the Web3 ecosystem. Built on blockchain technology, Spotnet provides a secure, transparent, and user-friendly experience for managing your digital assets, accessing decentralized finance (DeFi) services, and engaging with the broader Web3 community.',
},
{
type: 'text',
Expand All @@ -56,7 +56,7 @@ const OverviewPage = () => {
{
type: 'orderedList',
items: [
'Connect Your Wallet: Use any Web3-compatible wallet, such as MetaMask, to connect to [Product Name] securely and begin exploring the platform.',
'Connect Your Wallet: Use any Web3-compatible wallet, such as MetaMask, to connect to Spotnet securely and begin exploring the platform.',
'Choose A Service: Select from the various DeFi services, asset management tools, and community engagement features.',
'Transact Seamlessly: Every transaction is processed transparently on-chain, giving you control and visibility over your digital activities.',
],
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/pages/spotnet/defi-spring/DefiSpring.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export const DefiSpringPage = () => {
}, []);

const tableOfContents = [
{ id: 'introduction', name: 'Introduction', link: '#introduction' },
{ id: 'Introduction', name: 'Introduction', link: '#introduction' },
{
id: 'overview',
name: 'Program overview',
Expand All @@ -33,7 +33,7 @@ export const DefiSpringPage = () => {
{
type: 'text',
value:
'Welcome to the DeFi Spring Program!\nwhere you can earn rewards through the zkLend protocol. As part of this initiative, participants will have the opportunity to receive STRK token rewards for engaging with the platform. Here’s everything you need to know to get started and make the most of your participation.',
'Welcome to the DeFi Spring Program!\nWhere you can earn rewards through the zkLend protocol. As part of this initiative, participants will have the opportunity to receive STRK token rewards for engaging with the platform. Here’s everything you need to know to get started and make the most of your participation.',
},
],
},
Expand Down
86 changes: 86 additions & 0 deletions frontend/src/pages/terms-and-conditions/TermsAndConditions.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
import React, { useEffect } from 'react';
import './terms-and-conditions.css';
import ScrollButton from 'components/ui/scroll-button/ScrollButton';
import Sections from 'components/layout/sections/Sections';
import Sidebar from 'components/layout/sidebar/Sidebar';

const OverviewPage = () => {
useEffect(() => {
window.scrollTo(0, 0);
}, []);

const tableOfContents = [
{ id: 'welcome', name: 'Welcome', link: '#welcome' },
{
id: 'how-it-works',
name: 'How it works',
link: '#how-it-works',
children: [
{ id: 'connect-wallet', name: 'Connect Your Wallet', link: '#connect-wallet' },
{ id: 'choose-service', name: 'Choose A Service', link: '#choose-service' },
{ ud: 'transact-seamlessly', name: 'Transact Seamlessly', link: '#transact-seamlessly' },
],
},
{ id: 'supported-chains', name: 'Supported Chains', link: '#supported-chains' },
];

const sectionsData = [
{
id: 'welcome',
title: 'Welcome',
content: [
{
type: 'text',
value:
'Welcome to Spotnet, the decentralized platform designed to empower you with seamless access to the Web3 ecosystem. Built on blockchain technology, Spotnet provides a secure, transparent, and user-friendly experience for managing your digital assets, accessing decentralized finance (DeFi) services, and engaging with the broader Web3 community.',
},
{
type: 'text',
value: 'Key Features:',
},
{
type: 'list',
items: [
'Secure Asset Management: Store, track, and manage your digital assets with a security-first approach, utilizing smart contracts to protect your funds.',
'DeFi Integration: Access a suite of decentralized finance tools, including staking, lending, and borrowing, all from one intuitive interface.',
'Cross-Chain Compatibility: Interact with assets across multiple blockchain networks without needing to switch platforms.',
'Personalized Notifications: Enable real-time notifications for essential updates, such as changes in your health factor, to stay informed on your account status.',
],
},
],
},
{
id: 'how-it-works',
title: 'How It Works',
content: [
{
type: 'orderedList',
items: [
'Connect Your Wallet: Use any Web3-compatible wallet, such as MetaMask, to connect to Spotnet securely and begin exploring the platform.',
'Choose A Service: Select from the various DeFi services, asset management tools, and community engagement features.',
'Transact Seamlessly: Every transaction is processed transparently on-chain, giving you control and visibility over your digital activities.',
],
},
],
},
];

return (
<div className="overview-container">
<div>
<Sidebar items={tableOfContents} title={'Overview'} />
</div>

<div className="content">
<h1 className="content-title">Overview</h1>
<div className="section">
<Sections sections={sectionsData} />
</div>
</div>

<ScrollButton />
</div>
);
};

export default OverviewPage;
69 changes: 69 additions & 0 deletions frontend/src/pages/terms-and-conditions/terms-and-conditions.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
.documentation-container {
display: flex;
min-height: 100vh;
color: var(--primary);
position: relative;
padding-top: 70px;
}

.documentation-container::before {
content: '';
position: absolute;
top: 0;
right: 0;
width: 100%;
height: 100%;
background-image: radial-gradient(circle at 85% 15%, rgba(255, 255, 255, 0.25) 1px, transparent 1px),
radial-gradient(circle at 15% 85%, rgba(255, 255, 255, 0.25) 1px, transparent 1px),
radial-gradient(circle at 75% 75%, rgba(255, 255, 255, 0.25) 1px, transparent 1px);
background-size: 100px 100px;
pointer-events: none;
z-index: 0;
}

.main-content {
margin-left: 370px;
flex: 1;
background-size: cover;
background-position: center 39%;
position: relative;
min-height: 100vh;
}

.sections-container {
margin-left: 20px;
}

.main-title {
font-size: 2.5rem;
font-weight: 700;
margin-top: 94px;
margin-bottom: 3rem;
margin-left: 40px;
color: white !important;
background: white;
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
}

html {
scroll-behavior: smooth;
scroll-padding-top: 80px;
}

@media (max-width: 1440px) {
.main-content {
margin-left: 280px;
}
}

@media (max-width: 768px) {
.main-content {
margin-left: 0;
padding: 1rem;
}

.main-title {
font-size: 2rem;
}
}

0 comments on commit 80b2741

Please sign in to comment.