Skip to content

Latest commit

 

History

History
108 lines (72 loc) · 5.78 KB

README.md

File metadata and controls

108 lines (72 loc) · 5.78 KB
Raw

⚡ Live demo  |   🚀 Get Started

Build StatusFOSSA StatusCodacy Badge

Overview

Project LKIM As'adiyah Web App is the organization website for portofolio and user managements. The template is created based on Hoverboard Project team experience

Our goal is to allow organizers to set up a professional website with minimum resources. To get started you need only basic knowledge of web technologies and a free Firebase account.

Features

Feature Description
Fast and optimized 99/100 PWA on Lighthouse
Works offline shitty WiFi on the location is not a problem anymore
Mobile-first layouts optimized for small screens, Hoverboard can be installed as a native app on your phone
Push notifications remind about sessions in My schedule, session feedback or target users with a custom message
SEO optimized index all content and get to the top in search results
Pengurus and schedule management keep and update all information in the Firebase
My schedule let attendees save sessions they want to visit
Customizable theme change colors to match your style
Blog and News post announcements, updates and useful information

Getting Started

🌛 Read the set up guide or checkout the full documentation.

Updating

Here is a git workflow for updating your fork (or downloaded copy) to the latest version:

git remote add upstream https://github.com/kurnhyalcantara/lkim-asadiyah.git
git fetch upstream
git merge upstream/main
# resolve the merge conflicts in your editor
git add . -u
git commit -m 'Updated to the latest version'

Documentation

The Getting Started guide is probably a good first point of call!
📖 Full documentation.

Compatibility

✅ Compatible with latest two major versions of of browsers that support ES Modules.

Technology Stack

  • Polymer 3
  • Redux
  • Firebase
  • Service Worker
  • CSS Grid

Contributing

Awesome! Contributions of all kinds are greatly appreciated. To help smoothen the process we have a few non-exhaustive guidelines to follow which should get you going in no time.

Good First Issue

Issues labeled good first issue are a great way to ease into development on this project.

Help Wanted Label

Any other issue labeled help wanted is ready for a PR.

Using GitHub Issues

  • Feel free to use GitHub issues for questions, bug reports, and feature requests
  • Use the search feature to check for an existing issue
  • Include as much information as possible and provide any relevant resources (Eg. screenshots)
  • For bug reports ensure you have a reproducible test case
  • A pull request with a breaking test would be super preferable here but isn't required

Submitting a Pull Request

  • Squash commits
  • Lint your code with eslint (config provided)
  • Include relevant test updates/additions

Code of Conduct

Read the full version Code of Conduct.

Contributors

Authors: Kurniawan (Koord. Divisi Media LKIM)

Sponsoring

Most of the core team members, hoverboard contributors and contributors in the ecosystem do this open-source work in their free time. If you like this project and it makes your life easier, please donate.

License

FOSSA Status

The project is published under the MIT license. Feel free to clone and modify repo as you want, but don't forget to add a reference to authors :)