Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

merged #2

Merged
merged 8 commits into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
131 changes: 94 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,66 +2,123 @@
<a href="https://dscvit.com">
<img width="400" src="https://user-images.githubusercontent.com/56252312/159312411-58410727-3933-4224-b43e-4e9b627838a3.png#gh-light-mode-only" alt="GDSC VIT"/>
</a>
<h2 align="center"> < Insert Project Title Here > </h2>
<h4 align="center"> < Insert Project Description Here > <h4>
<h2 align="center">AO3 Chrome Extension</h2>
<h4 align="center">A powerful Chrome extension that enhances your Archive of Our Own (AO3) reading experience with AI-powered recommendations, custom themes, and comprehensive reading statistics.</h4>
</p>

---
[![Join Us](https://img.shields.io/badge/Join%20Us-Developer%20Student%20Clubs-red)](https://dsc.community.dev/vellore-institute-of-technology/)
[![Discord Chat](https://img.shields.io/discord/760928671698649098.svg)](https://discord.gg/498KVdSKWR)

[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE)
[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE)

[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](https://github.com/NitinTheGreat/ao3-chrome-extension/blob/dev/documentation.md)
[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](https://ao3-website.vercel.app/dashboard)

## Features
- [ ] < feature >
- [ ] < feature >
- [ ] < feature >
- [ ] < feature >
- [ ] AI-powered fanfiction recommendations based on reading history
- [ ] Custom themes with dark mode support
- [ ] Advanced tag filtering and search capabilities
- [ ] Reading statistics tracking
- [ ] Smart bookmark organization
- [ ] Reading progress tracker
- [ ] Enhanced user interface
- [ ] Cross-device sync for preferences

<br>

## Dependencies
- < dependency >
- < dependency >

- React 18.3.1
- Vite 5.3.4
- Axios 1.7.9
- Framer Motion 11.15.0
- React Router DOM 6.25.1
- TailwindCSS 3.4.10
- React Icons 5.3.0
- Lucide React 0.428.0

## Running

### Prerequisites
- Node.js (v14 or higher)
- Google Chrome browser

### Installation Steps

< directions to install >
1. Clone the repository
```bash
< insert code >
git clone https://github.com/GDSCVIT/ao3-extension.git
cd ao3-extension
```
2. Install dependencies
```shellscript
npm install
```
3. Build the extension
```shellscript
npm run build
```
4. Load the extension in Chrome:

< directions to execute >
- Open Chrome and navigate to `chrome://extensions/`
- Enable "Developer mode" in the top right corner
- Click "Load unpacked"
- Select the `dist` folder that was created during the build process

```bash
< insert code >
```

## Contributors

<table>
<tr align="center">
<td>
John Doe
<tr align="center">
<td>
Nitin Kumar Pandey
<p align="center">
<img src="https://temp-dep.vercel.app/_next/image?url=%2Fteam%2Ftechnical%2Fnitin.jpg&w=1920&q=75" width="150" height="150" alt="Nitin Kumar Pandey">
</p>
<p align="center">
<img src = "https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
<a href="https://github.com/NitinTheGreat">
<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
</a>
<a href="https://www.linkedin.com/in/nitinkrpandey">
<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
<p align="center">
<a href = "https://github.com/person1">
<img src = "http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height = "36" alt="GitHub"/>
</a>
<a href = "https://www.linkedin.com/in/person1">
<img src = "http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
</td>
</tr>
</table>

<p align="center">
Made with ❤ by <a href="https://dscvit.com">GDSC-VIT</a>
</p>
<p align="center">
Extension and Website
</p>
</td>
<td>
Varshith Kumar
<p align="center">
<img src="https://temp-dep.vercel.app/_next/image?url=%2Fteam%2Ftechnical%2Fvarshith.jpg&w=1920&q=75" width="150" height="150" alt="Varshith Kumar">
</p>
<p align="center">
<a href="https://github.com/var-code-5">
<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
</a>
<a href="https://www.linkedin.com/in/varshith-kumar-reddy-meda-02a7b02b3/">
<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
<p align="center">
Backend
</p>
</td>
<td>
Dipit Madan
<p align="center">
<img src="https://temp-dep.vercel.app/_next/image?url=%2Fteam%2Ftechnical%2Fdipit.jpeg&w=1920&q=75" width="150" height="150" alt="Dipit Madan">
</p>
<p align="center">
<a href="https://github.com/Dipit12">
<img src="http://www.iconninja.com/files/241/825/211/round-collaboration-social-github-code-circle-network-icon.svg" width="36" height="36" alt="GitHub"/>
</a>
<a href="https://www.linkedin.com/in/dipit-madan">
<img src="http://www.iconninja.com/files/863/607/751/network-linkedin-social-connection-circular-circle-media-icon.svg" width="36" height="36" alt="LinkedIn"/>
</a>
</p>
<p align="center"
<p align="center">
Machine Learning
</p>
</td>
</tr>
</table>
21 changes: 21 additions & 0 deletions ao3-chrome-extension/.eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:react/recommended',
'plugin:react/jsx-runtime',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
settings: { react: { version: '18.2' } },
plugins: ['react-refresh'],
rules: {
'react/jsx-no-target-blank': 'off',
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
53 changes: 53 additions & 0 deletions ao3-chrome-extension/dist/assets/main-BO7GYCs4.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions ao3-chrome-extension/dist/assets/main-fNCE5DMw.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
@tailwind base;@tailwind components;@tailwind utilities;
Loading
Loading