Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.42 KB

README.md

File metadata and controls

46 lines (34 loc) · 2.42 KB

Butter

Butter is an app that lets you catalog and track your movies. It works offline and also integrates with the ButterBackend to back up and store your catalogs.

Features

  • Offline Support: Store your catalogs locally and access them even without an internet connection.
  • Online Sync: Use a ButterBackend instance to synchronize your movie catalog across devices.
  • Robust Search: Use tags and formats to find the right movie.

Screenshots

Building

This project is built with Flutter. Ensure you have Flutter installed and configured on your machine.

  1. Install Flutter SDK: Follow the official Flutter installation guide based on your operating system.

    • Verify Flutter installation: 
      flutter doctor
    • Then make sure the dependencies are updated: 
      flutter pub get

  2. Set Up Emulator or Device: Ensure you have a connected Android/iOS device or set up an emulator.

  3. Use the app: If you want to use the app locally and offline, you can press "Use app offline" and skip the rest of the steps

  4. Start backend (Optional for Cloud Sync): If you want to sync your movie catalog online, set up ButterBackend on your local machine or a server. In the sign-in screen, set "Host" to the IP of the ButterBackend server.

  5. Create account: Create a username and password for your account, then sign in.

  6. Done! You're ready to go!

Contributions

Contributions are welcome! Feel free to fork the repository and submit pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.