Skip to content

RizkiKarianata/storiette

Repository files navigation

Welcome to Storiette! πŸ‘‹

Neutrans

Storiette is a simple open source project used to read a collection of short stories in Indonesian. This storiette is suitable for use by small children who like to read short stories. Built using Framework7. πŸ’–

Demo PageΒ Β Β  Documentation PageΒ Β Β 

πŸ’Ύ Requirements

  • Node.js - used for the entire application development process. Whether it's making an API or something
  • Web Browser - can be used as an emulator to build applications. Example [Chrome, Firefox, Safari & Opera]
  • Internet - because many use CDN and to make it easier to find solutions to all problems
  • Composer - make it easier for developers to manage PHP project dependencies
  • Android SDK - to simplify the process of building applications
  • Gradle - function to perform application building automatically
  • Java Development Kit - used for support in developing or building an application

🎯 How To Use

Using the built-in ready to use from the release (Recommended)

Download the latest project release from the Release Page. Open the Storiette project folder using a terminal and type npm run dev. To explore the source code you can use a text editor such as Visual Studio Code.

Build manually

  • Before starting, make sure you have Node.js installed first
  • If you have installed Node.js. Run the command git clone which is https://github.com/RizkiKarianata/storiette
  • Install the dependencies using the node package manager of your choice. For example run npm install in terminal
  • To run the application you can run the command npm run dev. And the application will automatically open using port 8080 on your default browser

Build to APK

  • You can run commands like in the NPM Scripts below by adding npm run. Example npm run build-dev-cordova-android on terminal

πŸ›  NPM Scripts

  • πŸ”₯ start - run development server
  • πŸ”§ dev - run development server
  • πŸ”§ build-dev - build web app using development mode (faster build without minification and optimization)
  • πŸ”§ build-prod - build web app for production
  • πŸ“± build-dev-cordova - build cordova app using development mode (faster build without minification and optimization)
  • πŸ“± build-prod-cordova - build cordova app
  • πŸ“± build-dev-cordova-ios - build cordova iOS app using development mode (faster build without minification and optimization)
  • πŸ“± build-prod-cordova-ios - build cordova iOS app
  • πŸ“± build-dev-cordova-android - build cordova Android app using development mode (faster build without minification and optimization)
  • πŸ“± build-prod-cordova-android - build cordova Android app

πŸ“‹ Documentation & Resources

πŸ§‘ Author

🀝 Contributing

Please follow Contributing Guide before contributing.

πŸ“ License

  • Copyright Β© 2022 Rizki Karianata
  • Storiette is an open source project licensed under the MIT license

β˜•οΈ Suppport & Donation

Love Storiette? Support this project by donating or sharing with others in need.

Made with ❀️ Rizki Karianata