Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matheus1714/nlw-shorts-summary-web
Summary for youtube shorts generated by AI
https://github.com/matheus1714/nlw-shorts-summary-web
nlw rocketseat rocketseat-nlw typescript vite
Last synced: 27 days ago
JSON representation
Summary for youtube shorts generated by AI
- Host: GitHub
- URL: https://github.com/matheus1714/nlw-shorts-summary-web
- Owner: Matheus1714
- License: mit
- Created: 2023-09-12T02:58:27.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-15T02:46:10.000Z (over 1 year ago)
- Last Synced: 2023-09-15T18:08:04.756Z (over 1 year ago)
- Topics: nlw, rocketseat, rocketseat-nlw, typescript, vite
- Language: TypeScript
- Homepage: https://nlw-shorts-summary-web.vercel.app
- Size: 2.36 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NLW | Shorts Summary 🚀
## Table of Content 📜
- [About](#about-ℹ️)
- [About NLW](#about-nlw-🚀)
- [Design](#design-📏)
- [Technologies Used](#technologies-used-⚙️)
- [Features](#features-✅)
- [Package Dependencies](#package-dependencies-⬇️)
- [Running the Project](#running-the-project-🏃)
- [Acknowledge](#acknowledge-☺️)
- [License](#license-📖)
## About ℹ️
Welcome to the Shots Summary Web project, where you can effortlessly get a summary for youtube shorts generated by AI.
## About NLW 🚀
NLW (Next Level Week) is an event organized by Rocketseat, dedicated to exploring cutting-edge technologies and empowering programmers to build high-quality projects quickly.
This project was created during NLW to embrace and master the latest technologies, resulting in an application powered by multiple advanced technologies.
## Design 📏
The design can be found in the [Figma Design]().
## Technologies Used ⚙️
The technologies utilized in this project include:
- [ReactJS + Vite](https://vitejs.dev/)
- [Typescript](https://www.typescriptlang.org/)
## Features ✅
- [x] Create Screens
- [x] Integrate a Back-end
- [x] Integrate OpenAI
## Package Dependencies ⬇️
Here is a list of the project's package dependencies:
```json
"dependencies": {
"@phosphor-icons/react": "^2.0.10",
"axios": "^1.5.0",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"devDependencies": {
"@types/react": "^18.2.15",
"@types/react-dom": "^18.2.7",
"@typescript-eslint/eslint-plugin": "^6.0.0",
"@typescript-eslint/parser": "^6.0.0",
"@vitejs/plugin-react": "^4.0.3",
"eslint": "^8.45.0",
"eslint-plugin-react-hooks": "^4.6.0",
"eslint-plugin-react-refresh": "^0.4.3",
"typescript": "^5.0.2",
"vite": "^4.4.5"
}
```
## Running the Project 🏃
To get started with the project, follow these steps:
1. Configure the api repository: https://github.com/Matheus1714/nlw-shorts-summary-api/
2. Install the project dependencies:
```
npm i
```
3. Execute the following command in your terminal to run the project:
```
npm run dev
```
_Obs: Both this repositories and api-repository must runnig together._
## Acknowledge ☺️
A special thanks to Rocketseat and their dedicated instructors who provide incredible content to the React community, making projects like this possible. Your guidance and support are greatly appreciated.
## License 📖
This project is open-source and is distributed under the MIT License. Feel free to explore, modify, and utilize the codebase according to the terms outlined in the license.