Skip to content

isti2415/researchsync

Repository files navigation

ResearchSync

A passion‑driven Next.js application designed to streamline literature review and collaboration for researchers. Born out of pure curiosity and love for building, ResearchSync aims to become an open‑source tool for academic collaboration—with planned Markdown editing, note sharing, and semantic paper linking in future releases.

Next.js TypeScript Tailwind CSS License: MIT

Repository: https://github.com/isti2415/researchsync


✨ Vision & Purpose

ResearchSync is built for academics, students, and enthusiasts who need a minimal but powerful space to:

  • Collect and organize research articles
  • Collaborate with peers in shared review sessions
  • Tag, summarize, and annotate papers
  • Integrate Markdown for structured note‑taking (coming soon)

The long‑term goal is to turn ResearchSync into a decentralized, knowledge‑driven research network, empowering open collaboration across disciplines.


🚀 Tech Stack

Layer Technology
Framework Next.js 14+ (App Router)
Language TypeScript
Styling Tailwind CSS
UI Library shadcn/ui (Radix primitives + Tailwind integration)
Package Manager Bun or npm/yarn
Data Layer Local JSON / Supabase / Prisma (planned)
Deployment Vercel / Netlify

✨ Features

  • 📚 Literature Management – Add, group, and view research entries.
  • 🧠 Collaboration‑Ready – Modular backend structure for future real‑time collaboration.
  • 🧾 Markdown Notes (Planned) – Inline and page‑level Markdown editors.
  • 🔍 Search & Tagging – Query by author, keyword, or topic (planned).
  • 🧩 Component‑Based UI – Organized, reusable, and responsive components.
  • 🎨 Tailwind‑Powered Design – Consistent, dark/light‑mode‑ready styling.
  • 🧱 App Router Architecture – Modular routes, server actions, and SEO‑ready metadata.
  • ⚙️ Scalable Config – Simple config structure for easy backend or API integration.

🗂️ Project Structure

researchsync/
│
├── app/                # App Router (pages, layouts, route handlers)
├── components/         # Reusable UI components (cards, inputs, lists)
├── hooks/              # Custom React hooks
├── lib/                # Utility functions and config helpers
├── public/             # Static assets (icons, images, fonts)
├── styles/             # Tailwind/global CSS
├── package.json        # Dependencies & scripts
├── tsconfig.json       # TypeScript configuration
├── next.config.js      # Next.js configuration
└── bun.lockb / yarn.lock / package-lock.json

🛠️ Getting Started

1. Clone Repository

git clone https://github.com/isti2415/researchsync.git
cd researchsync

2. Install Dependencies

Using Bun:

bun install

Or npm / yarn:

npm install
# or
yarn install

3. Run Development Server

bun dev
# or
npm run dev

Then visit: http://localhost:3000


🧩 Planned Enhancements

  • 📝 Markdown Support – Rich text and code block editing using Lexical or TipTap.
  • 🧠 Smart Recommendations – AI‑assisted literature suggestions.
  • 🤝 Team Collaboration – Shared reading lists and annotations.
  • 🔐 Auth Integration – Secure login with NextAuth / Clerk.
  • 📤 Cloud Sync – Optional Supabase or Firebase storage.
  • 📄 PDF Preview – Inline reading and note overlay.

📜 Scripts

Task Command
Dev Server bun dev / npm run dev
Lint bun run lint / npm run lint
Build bun run build / npm run build
Export (Static) bun run export / npm run export
Preview bun run start / npm run start

🌐 Deployment

Deploy anywhere that supports static or serverless Next.js apps:

  • Vercel – Ideal for SSR or static builds.
  • Netlify – Static export deployment.
  • GitHub Pages / Cloudflare Pages – For static hosting.

To build and export:

bun run build
bun run export

This generates a production‑ready static site in the /out directory.


🤝 Contributing

Contributions, ideas, and feature suggestions are always welcome!

  1. Fork the repo
  2. Create a feature branch: git checkout -b feat/awesome-idea
  3. Commit changes: git commit -m "feat: add awesome idea"
  4. Push and open a Pull Request

🧾 License

Licensed under the MIT License. See LICENSE for details.


Crafted with ❤️ and curiosity — ResearchSync exists to make research collaboration open, elegant, and accessible.

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors