Plutomierz

App for measuring the positive vibes using Pluta scale.

Overview

Project is available as both a web application and an Android app, providing users with a seamless experience across different platforms. The project leverages modern technologies such as TypeScript, JavaScript, React and Kotlin.

Launching the project

To launch the project, follow the steps below:

1. Web Application:
   • Navigate to the project directory.
   • Install dependencies using npm: npm install.
   • Start the development server: npm run dev.
2. Android Application:
   • Open the directory /android/ in Android Studio.
   • Sync the project with Gradle files.
   • Run the app on an emulator or a connected device.

WebSocket API Documentation

For detailed WebSocket API documentation, please refer to the API.md file.

Contributing

• Contributions are welcome! Feel free to submit a pull request or an issue.
• Branches should be named according to the following convention: feature/feature-name, bugfix/bug-name.

License

This project is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) License. You are free to use, distribute, and build upon this work, even commercially, as long as you credit the original authors and keep the name "Plutomierz".

See the LICENSE file for more details.