Skip to content

Latest commit

 

History

History
35 lines (22 loc) · 2.05 KB

README.md

File metadata and controls

35 lines (22 loc) · 2.05 KB
Raw

helth.app

Helth.app aims to be a minimalist web app for tracking calories, sodium, and water intake. It's a PWA built with SvelteKit. Helth.app doesn't use any third-party services for managing your data. Instead, data is stored locally on the device. It also has a sweet barcode scanner that can magically ✨ download packaged food items and the nutrients for that particular food by connecting you to the Open Food Facts API.

Getting started developing helth.app

  • Clone or fork this repository
  • npm install
  • npm run dev

To run tests, simply issue the command npm run test (for the full-suite) or npm run test:unit for unit tests.

Structure

Various reusable components are located in src/lib/. All data is stored locally in the user's browser and is managed via src/stores/stores with database connections handled at src/stores/db. Pages routes are found in src/routes/ and utility classes (mainly for transforming data) can be found in src/utils/. Playwright tests are located in tests while Vitest tests are located alongside the code they are testing but end with .test.ts.

3rd Party Tools

This development of this app is made easier by utilizing the following tools:

Building

To create a production version of helth.app:

npm run build

Production builds can be previewed with npm run preview. Helth.app currently uses the Cloudflare adapter but aims to be a static web application meaning it could be hosted from anywhere that can serve HTML, CSS, and JS files. This can be accomplished switching out the adapter with the SvelteKit static adapter.