diff --git a/client/src/App.css b/client/src/App.css index 0701c9c..5388108 100644 --- a/client/src/App.css +++ b/client/src/App.css @@ -118,6 +118,9 @@ .sidebar-footer { padding: 1.5rem; border-top: 1px solid var(--border-color); + display: flex; + align-items: center; + justify-content: space-between; } /* Main Content */ @@ -783,6 +786,16 @@ margin: 0 auto; } +.user-guide { + color: var(--text-color); +} + +.blue-link { + color: var(--primary-color); + text-decoration: underline; + margin-left: 4px; +} + @keyframes spin { 0% { transform: rotate(0deg); } 100% { transform: rotate(360deg); } diff --git a/client/src/App.js b/client/src/App.js index 5bdcf99..f5d439a 100644 --- a/client/src/App.js +++ b/client/src/App.js @@ -12,6 +12,7 @@ import Login from './components/auth/Login'; import Signup from './components/auth/Signup'; import ForgotPassword from './components/auth/ForgotPassword'; import ProtectedRoute from './components/auth/ProtectedRoute'; +import UserGuide from './components/UserGuide'; function App() { return ( @@ -64,6 +65,14 @@ function App() { } /> + + + + + + } /> + {/* Catch all route */} } /> diff --git a/client/src/assets/images/budgets-page.png b/client/src/assets/images/budgets-page.png new file mode 100644 index 0000000..a17e471 Binary files /dev/null and b/client/src/assets/images/budgets-page.png differ diff --git a/client/src/assets/images/edit-budget.png b/client/src/assets/images/edit-budget.png new file mode 100644 index 0000000..e9a57d3 Binary files /dev/null and b/client/src/assets/images/edit-budget.png differ diff --git a/client/src/assets/images/login-page.png b/client/src/assets/images/login-page.png new file mode 100644 index 0000000..c7575b2 Binary files /dev/null and b/client/src/assets/images/login-page.png differ diff --git a/client/src/assets/images/new-budget.png b/client/src/assets/images/new-budget.png new file mode 100644 index 0000000..869cce2 Binary files /dev/null and b/client/src/assets/images/new-budget.png differ diff --git a/client/src/assets/images/new-transaction.png b/client/src/assets/images/new-transaction.png new file mode 100644 index 0000000..a91a3c9 Binary files /dev/null and b/client/src/assets/images/new-transaction.png differ diff --git a/client/src/assets/images/signout.png b/client/src/assets/images/signout.png new file mode 100644 index 0000000..bcbdf2c Binary files /dev/null and b/client/src/assets/images/signout.png differ diff --git a/client/src/assets/images/signup-page.png b/client/src/assets/images/signup-page.png new file mode 100644 index 0000000..002f0c4 Binary files /dev/null and b/client/src/assets/images/signup-page.png differ diff --git a/client/src/assets/images/transactions-page.png b/client/src/assets/images/transactions-page.png new file mode 100644 index 0000000..4534df9 Binary files /dev/null and b/client/src/assets/images/transactions-page.png differ diff --git a/client/src/components/Layout.js b/client/src/components/Layout.js index 120d520..a0c56bd 100644 --- a/client/src/components/Layout.js +++ b/client/src/components/Layout.js @@ -102,6 +102,14 @@ const Layout = ({ children }) => {
+ setSidebarOpen(false)} + > + Docs +
diff --git a/client/src/components/UserGuide.js b/client/src/components/UserGuide.js new file mode 100644 index 0000000..958ac26 --- /dev/null +++ b/client/src/components/UserGuide.js @@ -0,0 +1,180 @@ +import loginImg from '../assets/images/login-page.png'; +import signUpImg from '../assets/images/signup-page.png'; +import budgetsImg from '../assets/images/budgets-page.png'; +import newBudgetImg from '../assets/images/new-budget.png'; +import editBudgetImg from '../assets/images/edit-budget.png'; +import transactionsImg from '../assets/images/transactions-page.png'; +import newTransactionImg from '../assets/images/new-transaction.png'; +import signOutImg from '../assets/images/signout.png'; + +const UserGuide = () => { + return ( +
+
+

User Guide

+

+ Welcome to SpendWise! This guide will help you understand how to + navigate the app, manage your budgets, track your expenses, and make + the most out of its features. +

+
+ +
+

What is SpendWise?

+

+ SpendWise is a personal finance management tool designed to help you + create budgets, categorize expenses, and monitor your financial health + with ease. You can sign up, log in, and start tracking your spending + in just a few minutes. +

+
+ +
+

Signup & Login

+
    +
  • + Click the Create one button on the login screen to + create a new account. +
    + Login Page +
    +
  • +
  • + Enter your name, email, and password, then click{" "} + Create Account. +
    + Sign Up Page +
    +
  • +
  • + Once registered, you can log in using your email and password. +
  • +
  • + To sign out, click the profile icon, then select Sign Out. +
    + Sign Out Page +
    +
  • +
+
+ +
+

Dashboard Overview

+

+ The Dashboard provides a summary of your financial status — total + income, expenses, and available balance. It also displays quick + insights into your spending patterns and active budgets. +

+
+ +
+

Budgets

+
    +
  • + Go to the Budgets page from the sidebar. +
    + Budgets Page +
    +
  • +
  • + Click New Budget to create a new one. +
    + New Budget Page +
    +
  • +
  • Enter the Budget Name and Financial Goal.
  • +
  • + Edit an existing budget by clicking the edit button. +
    + Edit Budget +
    +
  • +
+
+ +
+

Categories

+

+ Categories help organize your transactions for better insights. +

+
    +
  • View all categories under the Categories tab.
  • +
  • Add, edit, or remove categories as per your preferences.
  • +
+
+ +
+

Transactions

+
    +
  • + Navigate to the Transactions page. +
    + Transactions Page +
    +
  • +
  • + Use filters or the search bar to find transactions quickly. +
  • +
  • Delete or edit entries anytime to maintain accuracy.
  • +
  • + Click New Transaction to record an expense or income. +
    + New Transaction Page +
    +
  • +
  • Enter the description, budget, category, amount, date, and click Add Transaction to create a new transaction.
  • +
+
+ +
+

Need Help?

+

+ If you face any issues or have questions, please reach out via the project’s + + GitHub Issues page + + . +

+
+
+ ); +}; + +export default UserGuide;