-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3f699db
commit 796ad16
Showing
1 changed file
with
75 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,90 @@ | ||
# create-svelte | ||
[![Packagist][packagist-shield]][packagist-url] | ||
[![License][license-shield]][license-url] | ||
[![Stargazers][stars-shield]][stars-url] | ||
|
||
Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/master/packages/create-svelte). | ||
<!-- PROJECT LOGO --> | ||
<br /> | ||
<p align="center"> | ||
<a href="https://github.com/michaelhthomas/firefly-iii-svelte"> | ||
<img src="https://raw.githubusercontent.com/michaelhthomas/firefly-iii-svelte/main/assets/icon/icon.svg" alt="Firefly III Svelte" width="144" height="144"> | ||
</a> | ||
</p> | ||
<h1 align="center">Firefly III Svelte</h1> | ||
|
||
## Creating a project | ||
<p align="center"> | ||
A modern user interface for <a href="https://www.firefly-iii.org/">Firefly III</a>, built with Svelte and SvelteKit. | ||
<br /> | ||
<br /> | ||
<a href="https://demo.firefly-iii.org/">View the demo</a> | ||
· | ||
<a href="https://github.com/michaelhthomas/firefly-iii-svelte/issues">Report a bug</a> | ||
· | ||
<a href="https://github.com/michaelhthomas/firefly-iii-svelte/issues">Request a feature</a> | ||
· | ||
<a href="https://github.com/michaelhthomas/firefly-iii-svelte/discussions">Ask questions</a> | ||
</p> | ||
|
||
If you're seeing this, you've probably already done this step. Congrats! | ||
# Getting Started | ||
|
||
```bash | ||
# create a new project in the current directory | ||
npm create svelte@latest | ||
## Node.js | ||
|
||
# create a new project in my-app | ||
npm create svelte@latest my-app | ||
``` | ||
1. [Install Firefly III](https://docs.firefly-iii.org/firefly-iii/installation/docker/) | ||
|
||
## Developing | ||
1. Clone this repo | ||
|
||
```sh | ||
git clone https://github.com/michaelhthomas/firefly-iii-svelte/ | ||
``` | ||
|
||
1. Configure environment | ||
|
||
1. Copy `.env.example` to `.env` | ||
1. Update connection values for your Firefly III instance | ||
|
||
1. Install dependencies | ||
|
||
```sh | ||
pnpm i | ||
``` | ||
|
||
1. Build application | ||
|
||
```sh | ||
pnpm build | ||
``` | ||
|
||
1. Preview application | ||
|
||
```sh | ||
pnpm preview | ||
``` | ||
|
||
# Development | ||
|
||
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: | ||
```bash | ||
npm run dev | ||
1. Clone this repo | ||
```sh | ||
git clone https://github.com/michaelhthomas/firefly-iii-svelte/ | ||
``` | ||
1. Configure environment | ||
# or start the server and open the app in a new browser tab | ||
npm run dev -- --open | ||
``` | ||
1. Copy `.env.example` to `.env` | ||
1. Update connection values for your Firefly III instance | ||
## Building | ||
1. Install dependencies | ||
To create a production version of your app: | ||
```sh | ||
pnpm i | ||
``` | ||
```bash | ||
npm run build | ||
``` | ||
1. Start a development server | ||
You can preview the production build with `npm run preview`. | ||
```bash | ||
pnpm run dev | ||
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment. | ||
# or start the server and open the app in a new browser tab | ||
pnpm run dev -- --open | ||
``` |