Placemark Svelte
placemark-svelte
placemark-svelte is a modern, reactive web interface built with SvelteKit. It serves as the primary frontend for the placemark-core backend application at release 4.0.0 and later, consuming its REST API to provide a seamless user experience for managing points of interest.
Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Prerequisites
- NodeJS (LTS Version recommended)
- A running instance of placemark-core (v3.0.0+)
Installation
Clone the repository:
git clone [email protected]:schweigerjonas/placemark-svelte.git
cd placemark-svelte
Install dependencies:
npm install
Configure Environment Variables:
Create a file named .env in the root directory and add your configuration variables. At a minimum, you'll need:
# GitHub OAuth
GITHUB_CLIENT_ID=your_github_client_id_here
GITHUB_CLIENT_SECRET=your_github_client_secret_here
# Google OAuth
GOOGLE_CLIENT_ID=your_google_client_id_here
GOOGLE_CLIENT_SECRET=your_google_client_secret_here
Development
To run in development mode (with hot module replacement):
npm run dev -- --open
The server will typically start on http://localhost:5173.
Deployment
The application is deployed live at:
The backend API is deployed live at:
Note: In order for the frontend to work properly, it is necessary that the backend instance is spun up. This may take 1-2 minutes upon first visiting the website.
