README.md

English | hrvatski

a submission for EDIT Code School's advanced JavaScript course's finals (2022/2023) by Digitalna Dalmacija

---

⚠️ You are viewing the branch with all Firebase code replaced with stubs. You can "log in" and "log out", but it's just cosmetic.

🔗 Check it out running live! kikipnt on GitHub Pages (built from this branch)

If you wish to see the source code with ACTUAL functionality, check out the dev branch. If you wish to see the source code with NO Firebase code at all, check out the dev-no-firebase branch.

---

📌 kikipnt (pronounced "kiki point") is a web app for looking up places of the world. Powered by OpenStreetMap.

Inspired by this, I decided to take "kiki" from "kikiriki" (Croatian word for "peanuts") and add "pnt", a shortened version of "point". That's how I got the name kikipnt.

The project files themselves are in the kikipnt directory.

Note: For colored comments in the source code, I recommend the Better Comments Visual Studio Code extension.

⌨️ Building and running

(Working directory has to be kikipnt.)

The src/app directory has to contain the file __firebaseConfig.json that contains your Firebase project credentials.

Its format is as follows:

{
    "apiKey": "...",
    "authDomain": "...",
    "projectId": "...",
    "storageBucket": "...",
    "messagingSenderId": "...",
    "appId": "..."
}

⚠️ Warning: The Firebase functionalities of the app are unsafe. Use privately.

npm install - install all the necessary packages (check the dependency graph for a list)

npm run dev - build and run the development version

npm run prod - build and run the production version

Manual

Development

npx parcel --no-hmr

Production

npx parcel build --no-source-maps --public-url ./

📃 Repository resources

📄 Changelog

📝 Todo

🖼️ Screenshots

🛠️ Credits

Dependencies

Check the dependency graph.

App resources

Ubuntu font

Gantari font

Material Symbols

SVG spinners

Tools

Visual Studio Code

Inkscape

Other resources

Answers from Stack Overflow (necessary attributions are in the source code as comments)

MDN Web Docs

Licenses

MIT and BSD 2-Clause

Check the LICENSE file for more details.

---

Made by Luka Krešimir Mihovilović with 💙