Skip to content

armgit / papra

Public Imported from GitHub
0

The minimalistic document archiving platform.

feat(docs): updates README files (#125)

Corentin Thomassetb2d184822658
diff --git a/README.md b/README.md
index 2e4b6b0c..1c29698f 100644
--- a/README.md
+++ b/README.md
@@ -97,6 +97,17 @@ Papra would not have been possible without the following open-source projects:
- **[Drizzle](https://orm.drizzle.team/)**: A simple and lightweight ORM for Node.js.
- **[Better Auth](https://better-auth.com/)**: A simple and lightweight authentication library for Node.js.
- And other dependencies listed in the **[server package.json](./apps/papra-server/package.json)**
+- **Documentation**
+ - **[Astro](https://astro.build)**: A great static site generator.
+ - **[Starlight](https://starlight.astro.build)**: A module for Astro that provides a starting point for building documentation websites.
+ - **[HiDeoo/starlight-theme-rapide](https://github.com/HiDeoo/starlight-theme-rapide)**: A theme for Starlight.
+- **Project**
+ - **[PNPM Workspaces](https://pnpm.io/workspaces)**: A monorepo management tool.
+ - **[Github Actions](https://github.com/features/actions)**: For CI/CD.
+- **Infrastructure**
+ - **[Cloudflare Pages](https://pages.cloudflare.com/)**: For static site hosting.
+ - **[Render](https://render.com/)**: For backend hosting.
+ - **[Turso](https://turso.tech/)**: For production database.
### Inspiration
diff --git a/apps/docs/README.md b/apps/docs/README.md
index f9f6d31c..4f31903f 100644
--- a/apps/docs/README.md
+++ b/apps/docs/README.md
@@ -1,54 +1,22 @@
-# Starlight Starter Kit: Basics
+# Papra - Docs website
-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
+This is the documentation website for [Papra](https://papra.app).
-```
-npm create astro@latest -- --template starlight
-```
+This website is built using [Astro](https://astro.build), and based on the [Starlight](https://starlight.astro.build) module styled with [HiDeoo/starlight-theme-rapide](https://github.com/HiDeoo/starlight-theme-rapide) theme.
-[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
-[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
-[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
-[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
+## Development
-> πŸ§‘β€πŸš€ **Seasoned astronaut?** Delete this file. Have fun!
+To start the development server, run:
-## πŸš€ Project Structure
+```bash
+# Navigate to the docs directory
+cd apps/docs
-Inside of your Astro + Starlight project, you'll see the following folders and files:
+# Install dependencies
+pnpm install
+# Start the development server
+pnpm dev
```
-.
-β”œβ”€β”€ public/
-β”œβ”€β”€ src/
-β”‚ β”œβ”€β”€ assets/
-β”‚ β”œβ”€β”€ content/
-β”‚ β”‚ β”œβ”€β”€ docs/
-β”‚ └── content.config.ts
-β”œβ”€β”€ astro.config.mjs
-β”œβ”€β”€ package.json
-└── tsconfig.json
-```
-
-Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
-
-Images can be added to `src/assets/` and embedded in Markdown with a relative link.
-
-Static assets, like favicons, can be placed in the `public/` directory.
-
-## 🧞 Commands
-
-All commands are run from the root of the project, from a terminal:
-
-| Command | Action |
-| :------------------------ | :----------------------------------------------- |
-| `npm install` | Installs dependencies |
-| `npm run dev` | Starts local dev server at `localhost:4321` |
-| `npm run build` | Build your production site to `./dist/` |
-| `npm run preview` | Preview your build locally, before deploying |
-| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
-| `npm run astro -- --help` | Get help using the Astro CLI |
-
-## πŸ‘€ Want to learn more?
-Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
+The development server will start at [http://localhost:4321](http://localhost:4321).
diff --git a/apps/docs/package.json b/apps/docs/package.json
index 3de39b40..ebc67ce0 100644
--- a/apps/docs/package.json
+++ b/apps/docs/package.json
@@ -1,7 +1,11 @@
{
- "name": "docs",
+ "name": "@papra/docs",
"type": "module",
"version": "0.1.0",
+ "packageManager": "[email protected]",
+ "description": "Papra documentation website",
+ "author": "Corentin Thomasset <[email protected]> (https://corentin.tech)",
+ "license": "AGPL-3.0-or-later",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
diff --git a/apps/papra-client/README.md b/apps/papra-client/README.md
index 60a01224..a73a0f06 100644
--- a/apps/papra-client/README.md
+++ b/apps/papra-client/README.md
@@ -1,3 +1,23 @@
-# Papra app client
+# Papra - App Client
-This is the client app for Papra. It is a SolidJS SPA.
+This is the server for [Papra](https://papra.app).
+
+## Development
+
+> [!IMPORTANT]
+> Unless you are developing for the demo mode (`VITE_IS_DEMO_MODE=true` in adjacent `.env` file), you will need to have the server running locally. See the [server README](../papra-server/README.md) for instructions on how to start the server.
+
+To start the development server, run:
+
+```bash
+# Navigate to the docs directory
+cd apps/papra-client
+
+# Install dependencies
+pnpm install
+
+# Start the development server
+pnpm dev
+```
+
+The development server will be available at [http://localhost:3000](http://localhost:3000).
diff --git a/apps/papra-server/README.md b/apps/papra-server/README.md
new file mode 100644
index 00000000..78277529
--- /dev/null
+++ b/apps/papra-server/README.md
@@ -0,0 +1,20 @@
+# Papra - App server
+
+This is the server for [Papra](https://papra.app).
+
+## Development
+
+To start the development server, run:
+
+```bash
+# Navigate to the docs directory
+cd apps/papra-server
+
+# Install dependencies
+pnpm install
+
+# Start the development server
+pnpm dev
+```
+
+The development server will be available at [http://localhost:1221](http://localhost:1221).