Skip to content

nethmalgunawardhana/devthon_resonance

Repository files navigation

🎯 Resonance Frontend: Next.js Application

This is the Next.js frontend application for the Resonance project, providing a dynamic and responsive user interface.


🚀 Features

  • 🪙 Web3 integration with Metawallet for research funding
  • 🌐 Ethereum Sepolia testnet support and smart contract interaction
  • 🔍 AI-powered research recommendation system
  • 🔗 Integration with backend APIs and blockchain-based smart contracts
  • 🧠 LLM (Gemini) integration for summarization & recommendations
  • 📄 OpenAlex and Arxiv integration for real-time research data
  • 👨‍🎓 User authentication (Email/Password & Google OAuth)
  • ✅ Responsive and dynamic UI with Tailwind CSS

🔗 Links


🛠️ Getting Started with the Project

This project was bootstrapped with Create Next App.

Available Scripts

In the project directory, you can run:

npm run dev

Runs the app in development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm run build

Builds the app for production to the .next folder.
It correctly bundles Next.js in production mode and optimizes the build for the best performance.

npm run start

Starts the production server.
Ensure you've run npm run build first.


🛠️ Requirements

  • Node.js (v14 or above)
  • npm or yarn

⚙️ Setup Instructions

  1. Clone the Repository

    git clone [https://github.com/yourusername/resonance_frontend.git](https://github.com/nethmalgunawardhana/devthon_resonance.git)
    cd resonance_frontend
  2. Install Dependencies

    npm install
    # or
    yarn install
  3. Configure Environment Variables

    Create a .env.local file in the root of the frontend directory and add any necessary frontend environment variables. Example:

    NEXT_PUBLIC_BACKEND_API_URL=http://localhost:3000/api
    NEXT_PUBLIC_INFURA_API_KEY=YOUR_INFURA_PROJECT_ID
    NEXT_PUBLIC_CONTRACT_ADDRESS=YOUR_SMART_CONTRACT_ADDRESS
    NEXT_PUBLIC_GOOGLE_CLIENT_ID=YOUR_GOOGLE_CLIENT_ID
    

    Important: Do not commit your .env.local file to version control. Add it to your .gitignore file.

  4. Run the Application

    npm run dev
    # or
    yarn dev

    This will start the Next.js development server. Open your browser to http://localhost:3000 to view the application.


💻 Tech Stack (Frontend)

  • Framework: Next.js
  • Styling: Tailwind CSS
  • Auth: Firebase Auth, Google OAuth
  • Blockchain/Web3: Metawallet, Ethereum Sepolia Testnet
  • Smart Contracts: Solidity (ResearchFund)
  • Data Integration: OpenAlex, Arxiv
  • AI: LLM API (Gemini)

🤝 Team Members

  • Tharin Edirisinghe
  • Garuka Satharasinghe
  • Nethmal Gunawardhana
  • Harindu Hadithya
  • Sachintha Lakmin

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5

Languages