folfcoder/freshguard
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
4 commits 1 branch 0 tags 83 KiB
Svelte 58.8%
JavaScript 25.6%
TypeScript 7.3%
HTML 6.5%
CSS 1.8%
Find a file
Exact
folfcoder 99835584bb Update README.md
2024-12-23 17:12:25 +00:00
src feat: use env for api endpoint 2024-12-05 09:53:25 +07:00
static Initial commit 2024-11-30 17:55:43 +07:00
.gitignore Initial commit 2024-11-30 17:55:43 +07:00
.npmrc Initial commit 2024-11-30 17:55:43 +07:00
.prettierignore Initial commit 2024-11-30 17:55:43 +07:00
.prettierrc Initial commit 2024-11-30 17:55:43 +07:00
eslint.config.js Initial commit 2024-11-30 17:55:43 +07:00
package.json Initial commit 2024-11-30 17:55:43 +07:00
postcss.config.js Initial commit 2024-11-30 17:55:43 +07:00
README.md Update README.md 2024-12-23 17:12:25 +00:00
svelte.config.js Initial commit 2024-11-30 17:55:43 +07:00
tailwind.config.ts Initial commit 2024-11-30 17:55:43 +07:00
tsconfig.json Initial commit 2024-11-30 17:55:43 +07:00
vite.config.ts Initial commit 2024-11-30 17:55:43 +07:00
yarn.lock Initial commit 2024-11-30 17:55:43 +07:00

README.md

FreshGuard Frontend

FreshGuard Frontend is the user interface for the FreshGuard application, built using SvelteKit. It provides an intuitive and responsive way to classify apples as fresh or rotten, powered by the FreshGuard API.

Features

  • Modern UI: Built with SvelteKit for a fast and interactive user experience.
  • Easy Deployment: Compatible with Vercel, Netlify, and Cloudflare Pages.
  • Environment Configuration: Customizable API endpoint via environment variables.

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js 18 or higher
  • npm (Node package manager)

Installation

  1. Clone the repository:

    git clone https://git.fcd.im/folfcoder/freshguard.git
cd freshguard

  2. Install dependencies:

    npm install

  3. Set the API endpoint: Create a .env file in the root directory and add the following:

    PUBLIC_FRESHGUARD_ENDPOINT=<your-api-endpoint>

    Replace <your-api-endpoint> with the URL of the FreshGuard API.

  4. Run the application locally:

    npm run dev

    The application will be accessible at http://localhost:5173.

Deployment

FreshGuard Frontend is designed to be easily deployable on various platforms. Below are general steps for deploying:

Vercel

  1. Push your repository to a Git hosting service (e.g., GitHub).
  2. Connect your repository to Vercel.
  3. Set the PUBLIC_FRESHGUARD_ENDPOINT environment variable in the Vercel dashboard.
  4. Deploy the application.

Refer to Vercel Documentation for detailed instructions.

Netlify

  1. Push your repository to a Git hosting service (e.g., GitHub).
  2. Connect your repository to Netlify.
  3. Set the PUBLIC_FRESHGUARD_ENDPOINT environment variable in the Netlify dashboard.
  4. Deploy the application.

Refer to Netlify Documentation for detailed instructions.

Cloudflare Pages

  1. Push your repository to a Git hosting service (e.g., GitHub).
  2. Connect your repository to Cloudflare Pages.
  3. Set the PUBLIC_FRESHGUARD_ENDPOINT environment variable in the Cloudflare Pages settings.
  4. Deploy the application.

Refer to Cloudflare Pages Documentation for detailed instructions.