Skip to content

YNVSolutions/SwiftCause_Web

Repository files navigation

logo

Swift Cause

Modern Donation Platform for Nonprofits

Vercel

Tech Stack

HTML5 JavaScript Vercel GitHub Actions GitHub Git Tailwind CSS React

Author

Setup

  1. Clone the repository:

    git clone https://github.com/Yashraghuvans/SwiftCause.git
    cd SwiftCause
  2. Install dependencies:

    Using npm:

    npm install

    Using pnpm:

    pnpm install

Run Locally

  1. Start the development server:

    Using npm:

    npm run dev

    Using pnpm:

    pnpm dev
  2. Open your browser:

    Navigate to http://localhost:3000 to view the application.

Visual Studio Code

You would need to have the latest version of VS Code and VS Code Chrome Debugger Extension installed.

Then add the block below to your launch.json file and put it inside the .vscode folder in your app’s root directory.

{
  "version": "0.2.0",
  "configurations": [{
    "name": "Chrome",
    "type": "chrome",
    "request": "launch",
    "url": "http://localhost:3000",
    "webRoot": "${workspaceRoot}/src",
    "sourceMapPathOverrides": {
      "webpack:///src/*": "${webRoot}/*"
    }
  }]
}

Note: the URL may be different if you've made adjustments via the HOST or PORT environment variables.

Start your app by running npm start, and start debugging in VS Code by pressing F5 or by clicking the green debug icon. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor.

Having problems with VS Code Debugging? Please see their troubleshooting guide.

Supported Browsers

By default, the generated project usee the latest version of React.

You can refer to the React documentation for more information about supported browsers.

Install TailwindCSS (v4.0)

  1. Go to https://tailwindcss.com/
  2. Get started
  3. Under framework guides, select Next.js
  4. Follow the steps mentioned there to start using TailwindCSS

Recommendations

  1. You may use the extension Draw.io Integration on VScode to view the .drawio file.
  2. Prettier formatter recommended for code formatting.
  3. Use Tailwind CSS IntelliSense extension for Tailwind suggestions while coding.
  4. The project is using the latest versions of all the libraries mentioned above.
  5. Create and/or assign an issue to yourself before working on any feature.