Skip to content

Commit

Permalink
Fix docs and Dockerfiles
Browse files Browse the repository at this point in the history
  • Loading branch information
aumetra committed Sep 15, 2024
1 parent ceeae20 commit 45428de
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 46 deletions.
1 change: 0 additions & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,6 @@
frontend = pkgs.mkShell {
buildInputs = with pkgs; [
nodejs
yarn
nodePackages.svelte-language-server
nodePackages.typescript-language-server
];
Expand Down
39 changes: 2 additions & 37 deletions kitsune-fe/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,3 @@
# create-svelte
# Kitsune FE

Everything you need to build a Svelte project, powered by [`create-svelte`](https://github.com/sveltejs/kit/tree/main/packages/create-svelte).

## 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
```

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

> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
Frontend for the Kitsune Social Media server. Written with SvelteKit and TypeScript.
2 changes: 1 addition & 1 deletion kitsune-fe/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions kitsune/Dockerfile.dev
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ COPY . .
RUN cargo build --bin kitsune

FROM base AS frontend
RUN apk add --no-cache yarn
COPY kitsune-fe .
WORKDIR kitsune-fe
RUN yarn install && yarn build
RUN npm i && npm run build

FROM alpine:latest
WORKDIR app
Expand Down
3 changes: 1 addition & 2 deletions kitsune/Dockerfile.prod
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ COPY . .
RUN cargo build --release --bin kitsune

FROM base AS frontend
RUN apk add --no-cache yarn
COPY kitsune-fe .
WORKDIR kitsune-fe
RUN yarn install && yarn build
RUN npm i && npm run build

FROM alpine:latest
WORKDIR app
Expand Down
5 changes: 2 additions & 3 deletions website/src/content/docs/running/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ In order to build Kitsune, need a few dependencies. These are:
2. PostgreSQL as a dedicated DBMS
3. Redis for the job queue
4. [NodeJS](https://nodejs.org/en) v16+
5. [Yarn](https://classic.yarnpkg.com/en/docs/install)
6. Reverse Proxy (recommended: [Caddy](https://caddyserver.com/docs/install))
5. Reverse Proxy (recommended: [Caddy](https://caddyserver.com/docs/install))

Yes, that's really it. We don't need more. Kitsune is designed to use as few native dependencies as possible to make building from source easy!

Expand Down Expand Up @@ -54,7 +53,7 @@ Next, move into the newly created directory and then into the `kitsune-fe` direc
To do this run:

```bash
yarn install && yarn build
npm i && npm run build
```

Now move out of the directory and back into the main one. Then build the binaries in release mode.
Expand Down

0 comments on commit 45428de

Please sign in to comment.