Update README.md

README.md

@@ -1,38 +1,67 @@
-# sv
+# FreshGuard Frontend
 
-Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli).
+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.
 
-## Creating a project
+## 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.
 
-If you're seeing this, you've probably already done this step. Congrats!
+## Getting Started
 
-```bash
-# create a new project in the current directory
-npx sv create
+### Prerequisites
+Ensure you have the following installed:
+- Node.js 18 or higher
+- npm (Node package manager)
 
-# create a new project in my-app
-npx sv create my-app
-```
+### Installation
+1. Clone the repository:
+   ```bash
+   git clone https://git.fcd.im/folfcoder/freshguard.git
+   cd freshguard
+   ```
 
-## Developing
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
 
-Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
+3. Set the API endpoint:
+   Create a `.env` file in the root directory and add the following:
+   ```env
+   PUBLIC_FRESHGUARD_ENDPOINT=<your-api-endpoint>
+   ```
+   Replace `<your-api-endpoint>` with the URL of the FreshGuard API.
 
-```bash
-npm run dev
+4. Run the application locally:
+   ```bash
+   npm run dev
+   ```
+   The application will be accessible at `http://localhost:5173`.
 
-# or start the server and open the app in a new browser tab
-npm run dev -- --open
-```
+## Deployment
+FreshGuard Frontend is designed to be easily deployable on various platforms. Below are general steps for deploying:
 
-## Building
+### 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.
 
-To create a production version of your app:
+Refer to [Vercel Documentation](https://vercel.com/docs) for detailed instructions.
 
-```bash
-npm run build
-```
+### 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.
 
-You can preview the production build with `npm run preview`.
+Refer to [Netlify Documentation](https://docs.netlify.com/) for detailed instructions.
 
-> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment.
+### 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](https://developers.cloudflare.com/pages/) for detailed instructions.