Skip to content

Latest commit

 

History

History
68 lines (46 loc) · 2.38 KB

README.md

File metadata and controls

68 lines (46 loc) · 2.38 KB

VibeCheck

VibeCheck is a web application that uses AI to analyze the sentiment of text input, giving an opinion on whether it has good vibes, bad vibes, or somewhere in between. It's perfect for quickly analyzing emails, messages, or any other written communication to get a sense of the emotional tone.

Features

AI-powered sentiment analysis of text input User-friendly interface for easy copy and paste of text Provides a score of the vibe/sentiment between -1.0 (negative) and 1.0 (positive) Clearly indicates whether the text has good, bad, mixed, or neutral vibes Mobile-responsive design for use on any device

Usage

To use VibeCheck, simply copy and paste the text you want to analyze into the input field on the home page, and click the "Analyze" button. VibeCheck will return a score and an opinion on the overall vibe of the text.

Technology

VibeCheck is built using the following technologies:

React Google Natural Language Processing (NLP) API

Getting Started

To get started with VibeCheck, follow these steps:

Clone the repository Install the necessary dependencies (see package.json and requirements.txt) Run the server locally Open the application in a web browser

Contributing

Contributions to VibeCheck are welcome! To contribute:

Fork the repository Create a new branch Make your changes Push to your branch Create a pull request

License

This project is licensed under the MIT License.

This project was bootstrapped with Create React App.

Available Scripts (from create-react-app)

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.