Code Monkey home page Code Monkey logo

chat-app's Introduction

Welcome to Chat App! ๐Ÿ‘‹

Chat App

A simple application that is useful for knowing or calculating temperature conversions. 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 Chat App 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/chat-app
  • 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

๐Ÿ“† Release Date

  • v1.0.0 : 09 June 2022

๐Ÿง‘ Author

๐Ÿค Contributing

I really appreciate contributions, issues and feature requests because this application is far from perfect. Feel free to Pull Request and make changes to this project.

Since this is an open source project I finished it myself. There may be many features or things that could be improved or added. So I really appreciate your help.

Steps To Contribute

  • Fork it ( https://github.com/RizkiKarianata/chat-app )
  • Create your feature branch (git checkout -b my-new-feature)
  • Commit your changes (git commit -am 'Add some feature')
  • Push to the branch (git push origin my-new-feature)
  • Create a new Pull Request

Notes To Contribute

Make sure to not commit generated files from your dist folder. All changes need to be made in the source files located in the src folder.

  • Change the scss files to adapt styles
  • Change the nunjucks based html files or the content defining json files to adapt layout and content
  • Change the js files to adapt the application code

Always run a build and test the results before committing.

๐Ÿ“ License

  • Copyright ยฉ 2022 Rizki Karianata
  • Chat App is an open source project licensed under the MIT license

โ˜•๏ธ Suppport & Donation

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

Made with โค๏ธ Rizki Karianata

chat-app's People

Contributors

rizkikarianata avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.