Simple static Progressive Web Application
NodeJS dependencies may be installed via NPM...
npm installThis repository makes use of Git Submodules to track dependencies, to avoid incomplete downloads clone with the --recurse-submodules option...
git clone --recurse-submodules [email protected]:web-dev-examples/to-do-app.gitTo update tracked Git Submodules issue the following commands...
git pull
git submodule update --init --merge --recursiveTo force upgrade of Git Submodules...
git submodule update --init --merge --recursive --remoteNote, forcing and update of Git Submodule tracked dependencies may cause instabilities and/or merge conflicts; if however everything operates as expected after an update please consider submitting a Pull Request.
Navigate to the GitHub Pages hosted web-app, optionally install it as a PWA (Progressive Web Application), then add or remove to-do list items.
All data is saved within the web-browser via window.localStorage API, which is also used to restore lists and items. No server-side databases or scripts are required!
This repository may not be feature complete, Pull Requests that add necessary features or fix bugs are certainly welcomed.
Options for contributing to to-do-app and web-dev-examples
Start making a Fork of this repository to an account that you have write permissions for.
- Add remote for fork URL. The URL syntax is
[email protected]:<NAME>/<REPO>.git...
cd ~/git/hub/web-dev-examples/to-do-app
git remote add fork [email protected]:<NAME>/to-do-app.git- Install development dependencies
cd ~/git/hub/web-dev-examples/to-do-app
git submodule update --init --merge --recurse
npm install- Commit your changes and push to your fork, eg. to fix an issue...
cd ~/git/hub/web-dev-examples/to-do-app
git commit -F- <<'EOF'
:bug: Fixes #42 Issue
**Edits**
- `<SCRIPT-NAME>` script, fixes some bug reported in issue
EOF
git push fork gh-pagesNote, the
-uoption may be used to setforkas the default remote, eg.git push -u fork gh-pageshowever, this will also default theforkremote for pulling from too! Meaning that pulling updates fromoriginmust be done explicitly, eg.git pull origin gh-pages
- Then on GitHub submit a Pull Request through the Web-UI, the URL syntax is
https://github.com/<NAME>/<REPO>/pull/new/<BRANCH>
Note; to decrease the chances of your Pull Request needing modifications before being accepted, please check the dot-github repository for detailed contributing guidelines.
Thanks for even considering it!
Via Liberapay you may 
Regardless of if you're able to financially support projects such as to-do-app that web-dev-examples maintains, please consider sharing projects that are useful with others, because one of the goals of maintaining Open Source repositories is to provide value to the community.
-
Dev IO -- Destructuring JavaScript objects with default value
-
StackOverflow -- Typescript: Index signature is missing in type
Simple static Progressive Web Application
Copyright (C) 2021 S0AndS0
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, version 3 of the License.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
For further details review full length version of AGPL-3.0 License.
