|
2 | 2 | <a href="https://dscvit.com">
|
3 | 3 | <img width="400" src="https://user-images.githubusercontent.com/56252312/159312411-58410727-3933-4224-b43e-4e9b627838a3.png#gh-light-mode-only" alt="GDSC VIT"/>
|
4 | 4 | </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> |
7 | 7 | </p>
|
8 | 8 |
|
9 | 9 | ---
|
10 | 10 | [](https://dsc.community.dev/vellore-institute-of-technology/)
|
11 | 11 | [](https://discord.gg/498KVdSKWR)
|
12 | 12 |
|
13 | 13 | [](INSERT_LINK_FOR_DOCS_HERE)
|
14 |
| - [](INSERT_UI_LINK_HERE) |
15 |
| - |
| 14 | +[](INSERT_UI_LINK_HERE) |
16 | 15 |
|
17 | 16 | ## 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 |
22 | 25 |
|
23 | 26 | <br>
|
24 | 27 |
|
25 | 28 | ## 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 |
29 | 37 |
|
30 | 38 | ## Running
|
31 | 39 |
|
| 40 | +### Prerequisites |
| 41 | +- Node.js (v14 or higher) |
| 42 | +- Google Chrome browser |
| 43 | + |
| 44 | +### Installation Steps |
32 | 45 |
|
33 |
| -< directions to install > |
| 46 | +1. Clone the repository |
34 | 47 | ```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 |
36 | 58 | ```
|
| 59 | +4. Load the extension in Chrome: |
37 | 60 |
|
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 |
39 | 65 |
|
40 |
| -```bash |
41 |
| -< insert code > |
42 |
| -``` |
43 | 66 |
|
44 | 67 | ## Contributors
|
45 | 68 |
|
46 | 69 | <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://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Nitin Kumar Pandey"> |
| 75 | + </p> |
50 | 76 | <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/person1"> |
| 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> |
52 | 83 | </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 | + Frontend Developer |
| 86 | + </p> |
| 87 | + </td> |
| 88 | + <td> |
| 89 | + Varshith Kumar |
| 90 | + <p align="center"> |
| 91 | + <img src="https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Varshith Kumar"> |
| 92 | + </p> |
| 93 | + <p align="center"> |
| 94 | + <a href="https://github.com/person2"> |
| 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/person2"> |
| 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 Developer |
| 103 | + </p> |
| 104 | + </td> |
| 105 | + <td> |
| 106 | + Dipit Madan |
| 107 | + <p align="center"> |
| 108 | + <img src="https://dscvit.com/images/dsc-logo-square.svg" width="150" height="150" alt="Dipit Madan"> |
| 109 | + </p> |
| 110 | + <p align="center"> |
| 111 | + <a href="https://github.com/person3"> |
| 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/person3"> |
| 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` |
0 commit comments