217 | Article Summary 218 |
219 | 220 | {/* summary */} 221 |223 | {article.summary} 224 |
225 |├── .env.example
├── .eslintrc.cjs
├── .github
├── FUNDING.yml
├── dependabot.yml
└── images
│ ├── img1.png
│ ├── img2.png
│ ├── img3.png
│ ├── img_main.png
│ ├── stats.svg
│ └── step_api.png
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.md
├── README.md
├── SECURITY.md
├── index.html
├── package.json
├── postcss.config.js
├── public
├── _redirects
├── android-chrome-192x192.png
├── android-chrome-512x512.png
├── apple-touch-icon.png
├── browserconfig.xml
├── favicon-16x16.png
├── favicon-32x32.png
├── favicon.ico
├── googled107292f58992e0e.html
├── manifest.json
├── mstile-144x144.png
├── mstile-150x150.png
├── mstile-310x150.png
├── mstile-310x310.png
├── mstile-70x70.png
├── robots.txt
└── safari-pinned-tab.svg
├── src
├── App.css
├── App.jsx
├── assets
│ ├── copy.svg
│ ├── grid.svg
│ ├── index.js
│ ├── link.svg
│ ├── loader.svg
│ ├── logo.svg
│ └── tick.svg
├── components
│ ├── Demo.jsx
│ └── Hero.jsx
├── constants
│ └── index.jsx
├── main.jsx
└── services
│ ├── article.js
│ └── store.js
├── tailwind.config.js
├── vite.config.js
└── yarn.lock
/.env.example:
--------------------------------------------------------------------------------
1 | VITE_RAPIDAPI_ARTICLE_KEY=XXXXXXXXXXXXXXXXXXXXXXX
--------------------------------------------------------------------------------
/.eslintrc.cjs:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | env: { browser: true, es2020: true },
3 | extends: [
4 | 'eslint:recommended',
5 | 'plugin:react/recommended',
6 | 'plugin:react/jsx-runtime',
7 | 'plugin:react-hooks/recommended',
8 | ],
9 | parserOptions: { ecmaVersion: 'latest', sourceType: 'module' },
10 | settings: { react: { version: '18.2' } },
11 | plugins: ['react-refresh'],
12 | rules: {
13 | 'react-refresh/only-export-components': 'warn',
14 | },
15 | }
16 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | # These are supported funding model platforms
2 |
3 | github: [sanidhyy]# Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4 | patreon: sanidhy
5 | custom: https://www.buymeacoffee.com/sanidhy
6 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | # To get started with Dependabot version updates, you'll need to specify which
2 | # package ecosystems to update and where the package manifests are located.
3 | # Please see the documentation for all configuration options:
4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5 |
6 | version: 2
7 | updates:
8 | - package-ecosystem: "npm" # See documentation for possible values
9 | directory: "/" # Location of package manifests
10 | schedule:
11 | interval: "weekly"
12 |
--------------------------------------------------------------------------------
/.github/images/img1.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sanidhyy/ai-summarizer/7b6a3e7c1eb582f3defeb50a1d0fb6670294f5e0/.github/images/img1.png
--------------------------------------------------------------------------------
/.github/images/img2.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sanidhyy/ai-summarizer/7b6a3e7c1eb582f3defeb50a1d0fb6670294f5e0/.github/images/img2.png
--------------------------------------------------------------------------------
/.github/images/img3.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sanidhyy/ai-summarizer/7b6a3e7c1eb582f3defeb50a1d0fb6670294f5e0/.github/images/img3.png
--------------------------------------------------------------------------------
/.github/images/img_main.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sanidhyy/ai-summarizer/7b6a3e7c1eb582f3defeb50a1d0fb6670294f5e0/.github/images/img_main.png
--------------------------------------------------------------------------------
/.github/images/stats.svg:
--------------------------------------------------------------------------------
1 |
2 |
--------------------------------------------------------------------------------
/.github/images/step_api.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/sanidhyy/ai-summarizer/7b6a3e7c1eb582f3defeb50a1d0fb6670294f5e0/.github/images/step_api.png
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
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 | # Modules
11 | node_modules
12 | dist
13 | dist-ssr
14 | *.local
15 |
16 | # Environment Variables
17 | .env
18 | .env.local
19 | .env.development
20 | .env.production
21 | .env.staging
22 | .env.qa
23 |
24 | # Editor directories and files
25 | .vscode/*
26 | !.vscode/extensions.json
27 | .idea
28 | .DS_Store
29 | *.suo
30 | *.ntvs*
31 | *.njsproj
32 | *.sln
33 | *.sw?
34 |
35 | # Local Netlify folder
36 | .netlify
37 |
--------------------------------------------------------------------------------
/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, religion, or sexual identity
10 | and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | * Demonstrating empathy and kindness toward other people
21 | * Being respectful of differing opinions, viewpoints, and experiences
22 | * Giving and gracefully accepting constructive feedback
23 | * Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | * Focusing on what is best not just for us as individuals, but for the
26 | overall community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | * The use of sexualized language or imagery, and sexual attention or
31 | advances of any kind
32 | * Trolling, insulting or derogatory comments, and personal or political attacks
33 | * Public or private harassment
34 | * Publishing others' private information, such as a physical or email
35 | address, without their explicit permission
36 | * Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official e-mail address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | issues.
64 | All complaints will be reviewed and investigated promptly and fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series
86 | of actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or
93 | permanent ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within
113 | the community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.0, available at
119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120 |
121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct
122 | enforcement ladder](https://github.com/mozilla/diversity).
123 |
124 | [homepage]: https://www.contributor-covenant.org
125 |
126 | For answers to common questions about this code of conduct, see the FAQ at
127 | https://www.contributor-covenant.org/faq. Translations are available at
128 | https://www.contributor-covenant.org/translations.
129 |
--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | ## Contributing
2 |
3 | [fork]: https://github.com/Technical-Shubham-tech/ai-summarizer/fork
4 | [pr]: https://github.com/Technical-Shubham-tech/ai-summarizer/compare
5 | [style]: https://standardjs.com/
6 | [code-of-conduct]: CODE_OF_CONDUCT.md
7 |
8 | Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9 |
10 | Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.
11 |
12 | ## Issues and PRs
13 |
14 | If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.
15 |
16 | We'd also love PRs. If you're thinking of a large PR, we advise opening up an issue first to talk about it, though! Look at the links below if you're not sure how to open a PR.
17 |
18 | ## Submitting a pull request
19 |
20 | 1. [Fork][fork] and clone the repository.
21 | 1. Configure and install the dependencies: `npm install`.
22 | 1. Make sure the tests pass on your machine: `npm test`, note: these tests also apply the linter, so there's no need to lint separately.
23 | 1. Create a new branch: `git checkout -b my-branch-name`.
24 | 1. Make your change, add tests, and make sure the tests still pass.
25 | 1. Push to your fork and [submit a pull request][pr].
26 | 1. Pat your self on the back and wait for your pull request to be reviewed and merged.
27 |
28 | Here are a few things you can do that will increase the likelihood of your pull request being accepted:
29 |
30 | - Follow the [style guide][style] which is using standard. Any linting errors should be shown when running `npm test`.
31 | - Write and update tests.
32 | - Keep your changes as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
33 | - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
34 |
35 | Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocked you.
36 |
37 | ## Resources
38 |
39 | - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
40 | - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
41 | - [GitHub Help](https://help.github.com)
42 |
--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2023 Sanidhya Kr. Verma
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Summise - Modern OpenAI GPT-4 Article Summarizer
2 |
3 | 
4 |
5 | [](https://github.com/Technical-Shubham-tech "Ask Me Anything!")
6 | [](https://github.com/Technical-Shubham-tech/ai-summarizer/blob/main/LICENSE.md "GitHub license")
7 | [](https://github.com/Technical-Shubham-tech/ai-summarizer/commits/main "Maintenance")
8 | [](https://github.com/Technical-Shubham-tech/ai-summarizer/branches "GitHub branches")
9 | [](https://github.com/Technical-Shubham-tech/ai-summarizer/commits "Github commits")
10 | [](https://summise.netlify.app/ "Netlify Status")
11 | [](https://github.com/Technical-Shubham-tech/ai-summarizer/issues "GitHub issues")
12 | [](https://github.com/Technical-Shubham-tech/ai-summarizer/pulls "GitHub pull requests")
13 |
14 | ## ⚠️ Before you start
15 |
16 | 1. Make sure **Git** and **NodeJS** is installed.
17 | 2. Clone this repository to your local computer.
18 | 3. Create .env file in root folder.
19 | 4. Contents of **.env**:
20 |
21 | ```
22 | VITE_RAPIDAPI_ARTICLE_KEY=XXXXXXXXXXXXXXXXXXXXXXX
23 | ```
24 |
25 | 5. Now, to setup Article Summarizer API, go to [Rapid API Website](https://rapidapi.com/) and create an account.
26 |
27 | 6. Enable this API to fetch music data: [API: Article Extractor and Summarizer by Anthony](https://rapidapi.com/restyler/api/article-extractor-and-summarizer "API: Article Extractor and Summarizer by Anthony").
28 |
29 | 
30 |
31 | 7. After enabling you can get your API Keys and paste them in `.env` file in `VITE_RAPIDAPI_ARTICLE_KEY`.
32 |
33 | 8. Open terminal and run `npm install` or `yarn install` in root folder to install necessary packages.
34 |
35 | 9. Now app is fully configured :+1: and you can start using this app using `npm run dev` or `yarn dev`.
36 |
37 | **NOTE:** Make sure you don't share these keys publicaly.
38 |
39 | ## :camera: Screenshots:
40 |
41 | 
42 |
43 | 
44 |
45 | 
46 |
47 | ## :gear: Built with
48 |
49 | [](https://developer.mozilla.org/en-US/docs/Web/JavaScript "JavaScript") [](https://react.dev/ "React JS") [](https://tailwindcss.com/ "Tailwind CSS") [](https://vitejs.dev/ "Vite")
50 |
51 | ## :wrench: Stats
52 |
53 | [](https://pagespeed.web.dev/ "Stats for this App")
54 |
55 | ## :raised_hands: Contribute
56 |
57 | You might encounter some bugs while using this app. You are more than welcome to contribute. Just submit changes via pull request and I will review them before merging. Make sure you follow community guidelines.
58 |
59 | ## Buy Me a Coffee 🍺
60 |
61 | [](https://www.buymeacoffee.com/sanidhy "Buy me a Coffee")
62 |
63 | ## :rocket: Follow Me
64 |
65 | [](https://github.com/Technical-Shubham-tech "Follow Me")
66 | [](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2FTechnical-Shubham-tech%2Fmedical-chat-app "Tweet")
67 | [](https://www.youtube.com/channel/UCNAz_hUVBG2ZUN8TVm0bmYw "Subscribe my Channel")
68 |
69 | ## :star: Give A Star
70 |
71 | You can also give this repository a star to show more people and they can use this repository.
72 |
73 | ## :books: Available Scripts
74 |
75 | In the project directory, you can run:
76 |
77 | ### `yarn run dev`
78 |
79 | Runs the app in the development mode.\
80 | Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
81 |
82 | The page will reload when you make changes.\
83 | You may also see any lint errors in the console.
84 |
85 | ### `yarn test`
86 |
87 | Launches the test runner in the interactive watch mode.\
88 | See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
89 |
90 | ### `yarn run build`
91 |
92 | Builds the app for production to the `dist` folder.\
93 | It correctly bundles React in production mode and optimizes the build for the best performance.
94 |
95 | The build is minified and the filenames include the hashes.\
96 | Your app is ready to be deployed!
97 |
98 | See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
99 |
100 | ### `yarn eject`
101 |
102 | **Note: this is a one-way operation. Once you `eject`, you can't go back!**
103 |
104 | If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
105 |
106 | Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
107 |
108 | You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
109 |
110 | ## :page_with_curl: Learn More
111 |
112 | You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
113 |
114 | To learn React, check out the [React documentation](https://reactjs.org/).
115 |
116 | ### Code Splitting
117 |
118 | This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
119 |
120 | ### Analyzing the Bundle Size
121 |
122 | This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
123 |
124 | ### Making a Progressive Web App
125 |
126 | This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
127 |
128 | ### Advanced Configuration
129 |
130 | This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
131 |
132 | ### Deployment
133 |
134 | This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
135 |
136 | ### `yarn run build` fails to minify
137 |
138 | This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
139 |
--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 |
3 | ## Supported Versions
4 |
5 | Use this section to tell people about which versions of your project are
6 | currently being supported with security updates.
7 |
8 | | Version | Supported |
9 | | ------- | ------------------ |
10 | | 5.1.x | :white_check_mark: |
11 | | 5.0.x | :x: |
12 | | 4.0.x | :white_check_mark: |
13 | | < 4.0 | :x: |
14 |
15 | ## Reporting a Vulnerability
16 |
17 | Use this section to tell people how to report a vulnerability.
18 |
19 | Tell them where to go, how often they can expect to get an update on a
20 | reported vulnerability, what to expect if the vulnerability is accepted or
21 | declined, etc.
22 |
--------------------------------------------------------------------------------
/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
205 | Well, that wasn't supposed to happen...
206 |
207 |
208 | {error?.data?.error}
209 |
210 |
223 | {article.summary} 224 |
225 |