Skip to content

Commit

Permalink
change Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
derGraph committed Aug 10, 2024
1 parent ae4202b commit 2c928b3
Showing 1 changed file with 6 additions and 32 deletions.
38 changes: 6 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,11 @@
# create-svelte
# sailBlog
### This is a project to share and record voyage data when sailing. It is my first attemt in svelte.

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).
It uses prisma for Database and lucia for authentication. The project should adhere to EU-GDPR rules.
The companion app is written in flutter and is used to inject the data into the database.
All API-Endpoints used in the project are also available to the public. Log in via POST to /login and then use the cookie!

## Creating a project

If you're seeing this, you've probably already done this step. Congrats!

```bash
# create a new project in the current directory
npm create svelte@latest

# create a new project in my-app
npm create svelte@latest my-app
```

## Developing

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

# or start the server and open the app in a new browser tab
npm run dev -- --open
```

## Building

To create a production version of your app:

```bash
npm run build
```
The project is auto built into a docker container published to Github Packages!

You can preview the production build with `npm run preview`.

Expand Down

0 comments on commit 2c928b3

Please sign in to comment.