Skip to content

Latest commit

 

History

History
114 lines (76 loc) · 3.66 KB

README.md

File metadata and controls

114 lines (76 loc) · 3.66 KB
Raw

Storyloom Flutter App

Welcome to the Storyloom Flutter App repository! This project aims to bring the Storyloom experience to mobile devices by developing a Flutter-based app that allows users to explore folktales from around the world, connect with their cultural roots, and learn languages through engaging stories.

About Storyloom

Storyloom is a platform dedicated to preserving the authentic culture of countries through stories. The platform offers a rich collection of folktales in multiple languages, giving users an opportunity to reconnect with their heritage and explore the world through narratives.

This Flutter app will serve as the mobile extension of Storyloom, providing users with a seamless experience to explore and read folktales from their phones or tablets.

Features

  • Explore folktales from various countries and cultures.
  • Multi-language support for learning and immersion.
  • User-friendly mobile interface for an immersive reading experience.
  • Regular updates with new stories and features.

Tech Stack

  • Flutter - for building a cross-platform mobile app (iOS & Android).
  • Dart - programming language used in Flutter development.
  • Backend Integration - connecting to the Storyloom API.

Figma Design

You can view the Figma design for Storyloom using the following links:

Getting Started

Prerequisites

To get started with this project, make sure you have the following installed:

Setup Instructions

  1. Clone the repository:

    git clone https://github.com/your-username/storyloom-flutter-app.git

  2. Navigate to the project directory:

    cd storyloom-flutter-app

  3. Install the dependencies:

    flutter pub get

  4. Run the app on an emulator or connected device:

    flutter run

Setup git hooks

Run git config core.hooksPath .githooks to set up the git hooks

Hide generated files from the editor

For VSCode, add the following to your .vscode/settings.json:

{
    "files.exclude": {
        "/*.freezed.dart": true,
        "/*.g.dart": true,
    },
}

Contributing

We welcome contributions from everyone! This repository is open for contributions as part of Hacktoberfest.

How to Contribute

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Commit your changes and open a pull request.
  4. Ensure that your pull request follows the contribution guidelines.

Hacktoberfest Contributions

We're participating in Hacktoberfest 2024! If you'd like to contribute, here are some ways you can help:

  • Fix bugs or enhance the app's features.
  • Work on improving the UI/UX of the app.
  • Add support for more languages or improve localization.
  • Suggest new features that can make the app better for users.
  • Write tests to ensure code quality.

Be sure to tag your pull request with the hacktoberfest-accepted label to count toward your Hacktoberfest contributions!

Rules for Contribution

License

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

Contact

For any questions or suggestions, feel free to reach out: