Skip to content

Commit 59e8cd2

Browse files
NitinTheGreatNitinTheGreat
authored
fix: muktiple fixes(#2)
* merged * changes to readme * removed readme * added documentation.md * change doc link * added links to readme * changes to manifest * push dist folder
1 parent 44db09c commit 59e8cd2

34 files changed

+8100
-37
lines changed

‎.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
15+
# Editor directories and files
16+
.vscode/*
17+
!.vscode/extensions.json
18+
.idea
19+
.DS_Store
20+
*.suo
21+
*.ntvs*
22+
*.njsproj
23+
*.sln
24+
*.sw?

‎README.md

+94-37
Original file line numberDiff line numberDiff line change
@@ -2,66 +2,123 @@
22
<a href="https://dscvit.com">
33
<img width="400" src="https://user-images.githubusercontent.com/56252312/159312411-58410727-3933-4224-b43e-4e9b627838a3.png#gh-light-mode-only" alt="GDSC VIT"/>
44
</a>
5-
<h2 align="center"> < Insert Project Title Here > </h2>
6-
<h4 align="center"> < Insert Project Description Here > <h4>
5+
<h2 align="center">AO3 Chrome Extension</h2>
6+
<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>
77
</p>
88

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

13-
[![DOCS](https://img.shields.io/badge/Documentation-see%20docs-green?style=flat-square&logo=appveyor)](INSERT_LINK_FOR_DOCS_HERE)
14-
[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](INSERT_UI_LINK_HERE)
15-
13+
[![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)
14+
[![UI ](https://img.shields.io/badge/User%20Interface-Link%20to%20UI-orange?style=flat-square&logo=appveyor)](https://ao3-website.vercel.app/dashboard)
1615

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

2326
<br>
2427

2528
## Dependencies
26-
- < dependency >
27-
- < dependency >
28-
29+
- React 18.3.1
30+
- Vite 5.3.4
31+
- Axios 1.7.9
32+
- Framer Motion 11.15.0
33+
- React Router DOM 6.25.1
34+
- TailwindCSS 3.4.10
35+
- React Icons 5.3.0
36+
- Lucide React 0.428.0
2937

3038
## Running
3139

40+
### Prerequisites
41+
- Node.js (v14 or higher)
42+
- Google Chrome browser
43+
44+
### Installation Steps
3245

33-
< directions to install >
46+
1. Clone the repository
3447
```bash
35-
< insert code >
48+
git clone https://github.com/GDSCVIT/ao3-extension.git
49+
cd ao3-extension
50+
```
51+
2. Install dependencies
52+
```shellscript
53+
npm install
54+
```
55+
3. Build the extension
56+
```shellscript
57+
npm run build
3658
```
59+
4. Load the extension in Chrome:
3760

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

40-
```bash
41-
< insert code >
42-
```
4366

4467
## Contributors
4568

4669
<table>
47-
<tr align="center">
48-
<td>
49-
John Doe
70+
<tr align="center">
71+
<td>
72+
Nitin Kumar Pandey
73+
<p align="center">
74+
<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">
75+
</p>
5076
<p align="center">
51-
<img src = "https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Your Name Here (Insert Your Image Link In Src">
77+
<a href="https://github.com/NitinTheGreat">
78+
<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"/>
79+
</a>
80+
<a href="https://www.linkedin.com/in/nitinkrpandey">
81+
<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"/>
82+
</a>
5283
</p>
53-
<p align="center">
54-
<a href = "https://github.com/person1">
55-
<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"/>
56-
</a>
57-
<a href = "https://www.linkedin.com/in/person1">
58-
<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"/>
59-
</a>
60-
</p>
61-
</td>
62-
</tr>
63-
</table>
64-
65-
<p align="center">
66-
Made with ❤ by <a href="https://dscvit.com">GDSC-VIT</a>
67-
</p>
84+
<p align="center">
85+
Extension and Website
86+
</p>
87+
</td>
88+
<td>
89+
Varshith Kumar
90+
<p align="center">
91+
<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">
92+
</p>
93+
<p align="center">
94+
<a href="https://github.com/var-code-5">
95+
<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"/>
96+
</a>
97+
<a href="https://www.linkedin.com/in/varshith-kumar-reddy-meda-02a7b02b3/">
98+
<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"/>
99+
</a>
100+
</p>
101+
<p align="center">
102+
Backend
103+
</p>
104+
</td>
105+
<td>
106+
Dipit Madan
107+
<p align="center">
108+
<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">
109+
</p>
110+
<p align="center">
111+
<a href="https://github.com/Dipit12">
112+
<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"/>
113+
</a>
114+
<a href="https://www.linkedin.com/in/dipit-madan">
115+
<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"/>
116+
</a>
117+
</p>
118+
<p align="center"
119+
<p align="center">
120+
Machine Learning
121+
</p>
122+
</td>
123+
</tr>
124+
</table>

‎ao3-chrome-extension/.eslintrc.cjs

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
module.exports = {
2+
root: true,
3+
env: { browser: true, es2020: true },
4+
extends: [
5+
'eslint:recommended',
6+
'plugin:react/recommended',
7+
'plugin:react/jsx-runtime',
8+
'plugin:react-hooks/recommended',
9+
],
10+
ignorePatterns: ['dist', '.eslintrc.cjs'],
11+
parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
12+
settings: { react: { version: '18.2' } },
13+
plugins: ['react-refresh'],
14+
rules: {
15+
'react/jsx-no-target-blank': 'off',
16+
'react-refresh/only-export-components': [
17+
'warn',
18+
{ allowConstantExport: true },
19+
],
20+
},
21+
}

‎ao3-chrome-extension/dist/assets/main-BO7GYCs4.js

+53
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ao3-chrome-extension/dist/assets/main-fNCE5DMw.css

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
@tailwind base;@tailwind components;@tailwind utilities;

0 commit comments

Comments
 (0)