aboutsummaryrefslogtreecommitdiffstats
path: root/public/projects/js-small-apps/users-list/README.md
diff options
context:
space:
mode:
authorArmand Philippot <git@armandphilippot.com>2022-02-20 16:11:50 +0100
committerArmand Philippot <git@armandphilippot.com>2022-02-20 16:15:08 +0100
commit73a5c7fae9ffbe9ada721148c8c454a643aceebe (patch)
treec8fad013ed9b5dd589add87f8d45cf02bbfc6e91 /public/projects/js-small-apps/users-list/README.md
parentb01239fbdcc5bbc5921f73ec0e8fee7bedd5c8e8 (diff)
chore!: restructure repo
I separated public files from the config/dev files. It improves repo readability. I also moved dotenv helper to public/inc directory and extract the Matomo tracker in the same directory.
Diffstat (limited to 'public/projects/js-small-apps/users-list/README.md')
-rw-r--r--public/projects/js-small-apps/users-list/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/public/projects/js-small-apps/users-list/README.md b/public/projects/js-small-apps/users-list/README.md
new file mode 100644
index 0000000..4c10232
--- /dev/null
+++ b/public/projects/js-small-apps/users-list/README.md
@@ -0,0 +1,18 @@
+# Users list
+
+An users list implementation using Javascript.
+
+The implementation is inspired by the [CauseEffect app from @florinpop17 repo](https://github.com/florinpop17/app-ideas/blob/master/Projects/1-Beginner/Cause-Effect-App.md).
+
+However, I made small changes:
+
+- Instead of hard coding the users objects, this implementation uses `fetch()` to retrieve data from an API.
+- I implemented "routing": user info can be displayed if URL contains the user parameter.
+
+## Preview
+
+You can see a live preview here: https://demo.armandphilippot.com/#users-list
+
+## License
+
+This project is open-source and available under the [MIT License](../LICENSE).