Compare commits
53 Commits
v1.1.7-bet
...
v2.0.0-bet
Author | SHA1 | Date | |
---|---|---|---|
|
c1baa3a16d | ||
|
cfc103e056 | ||
|
1a0b565ae0 | ||
|
37a30f1bd7 | ||
|
d7bdffe096 | ||
|
277fa3ce28 | ||
|
11b2c5d9a1 | ||
|
0e1ea0f2ef | ||
|
a8c53afe8c | ||
|
5b3dab7c75 | ||
|
57d89e5807 | ||
|
107a467bcc | ||
|
792183bbb3 | ||
|
a12183d4a8 | ||
|
359d0a0403 | ||
|
c3967eca72 | ||
|
6898dd8d1b | ||
|
e80de3576c | ||
|
17dd85241c | ||
|
f7124ec346 | ||
|
b443fcb010 | ||
|
d106b5346f | ||
|
7a6df51308 | ||
|
e40254fea6 | ||
|
a3ed862ed9 | ||
|
7904333b15 | ||
|
57af56ff7e | ||
|
a2a5b6a88b | ||
|
fccc9d559f | ||
|
c1fc52c302 | ||
|
dca252827c | ||
|
32bc17c373 | ||
|
efba0b75dc | ||
|
a119ab4d46 | ||
|
d25f493c7a | ||
|
78e2d05d6c | ||
|
564ff43843 | ||
|
5aea36fd98 | ||
|
7d6e484c2b | ||
|
e50abf953e | ||
|
15dce5dab1 | ||
|
20fee6b449 | ||
|
e03ca7e0dc | ||
|
ab6c634782 | ||
|
6a933891c8 | ||
|
5cd7acc158 | ||
|
b4cecf9e32 | ||
|
e55f090235 | ||
|
0a738430e7 | ||
|
6c7117cc14 | ||
|
61cf88b41f | ||
|
b077154c22 | ||
|
9e35d27497 |
3
.gitignore
vendored
@@ -27,3 +27,6 @@ apps/web/*.sw?
|
||||
apps/server/node_modules
|
||||
apps/server/.env
|
||||
apps/server/dist/*
|
||||
|
||||
#DEFAULT
|
||||
.env
|
3
Makefile
@@ -1,3 +0,0 @@
|
||||
gen-compose:
|
||||
chmod +x ./scripts/generate-docker-compose.sh
|
||||
./scripts/generate-docker-compose.sh
|
12
README.md
@@ -1,13 +1,13 @@
|
||||
# 🌴 Palmr. - Open-Source File Transfer
|
||||
|
||||
<p align="center">
|
||||
<img src="https://github.com/user-attachments/assets/dc2a105a-e66b-4db5-b56c-87d872a1edf8" alt="Palmr Logo" style="width: 100%;">
|
||||
<img src="https://res.cloudinary.com/technical-intelligence/image/upload/v1745548261/Palmr./banner_roxtph.png" alt="Palmr Logo" style="width: 100%;">
|
||||
</p>
|
||||
|
||||
**Palmr.** is a **flexible** and **open-source** alternative to file transfer services like **WeTransfer**, **SendGB**, **Send Anywhere**, and **Files.fm**.
|
||||
|
||||
|
||||
🔗 **For detailed documentation visit:** [Palmr. - Documentation](https://palmr-docs.kyantech.com.br)
|
||||
🔗 **For detailed documentation visit:** [Palmr. - Documentation](https://palmr.kyantech.com.br)
|
||||
|
||||
## 📌 Why Choose Palmr.?
|
||||
|
||||
@@ -20,7 +20,7 @@
|
||||
### **Palmr.** is built with a focus on **performance**, **scalability**, and **security**.
|
||||
|
||||
<div align="center">
|
||||
<img src="https://i.ibb.co/3Y8bhm7v/Captura-de-Tela-2025-04-03-s-10-56-12.png" style="width: 100%; border-radius: 15px;" />
|
||||
<img src="https://res.cloudinary.com/technical-intelligence/image/upload/v1745548231/Palmr./Captura_de_Tela_2025-04-24_a%CC%80s_23.24.26_kr4hsl.png" style="width: 100%; border-radius: 15px;" />
|
||||
</div>
|
||||
|
||||
|
||||
@@ -30,12 +30,12 @@
|
||||
- **MinIO (Object Storage)** – AWS S3-compatible storage for high availability.
|
||||
|
||||
### **Frontend**
|
||||
- **React + TypeScript + Vite** – Modern, interactive, and fast web interface.
|
||||
- **NextJS 15 + TypeScript + Shadcn/ui** – Modern and fast web interface.
|
||||
|
||||
|
||||
## 🛠️ How It Works
|
||||
|
||||
1. **Web Interface** → Built with React, TypeScript, and Vite for a seamless user experience.
|
||||
1. **Web Interface** → Built with Next, React and TypeScript for a seamless user experience.
|
||||
2. **Backend API** → Fastify handles requests and interacts with storage.
|
||||
3. **Database** → PostgreSQL stores metadata and transactional data.
|
||||
4. **Storage** → MinIO ensures reliable file storage and retrieval.
|
||||
@@ -43,7 +43,7 @@
|
||||
|
||||
## 👨💻 Core Maintainers
|
||||
|
||||
| **Daniel Luiz Alves** |
|
||||
| [**Daniel Luiz Alves**](https://github.com/danielalves96) |
|
||||
|------------------|
|
||||
| <img src="https://github.com/danielalves96.png" width="150px" alt="Daniel Luiz Alves" /> |
|
||||
|
||||
|
3
apps/docs/.eslintrc.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"extends": ["next/core-web-vitals", "next/typescript"]
|
||||
}
|
31
apps/docs/.gitignore
vendored
@@ -1,3 +1,28 @@
|
||||
node_modules
|
||||
.astro
|
||||
dist
|
||||
# deps
|
||||
/node_modules
|
||||
|
||||
# generated content
|
||||
.contentlayer
|
||||
.content-collections
|
||||
.source
|
||||
|
||||
# test & build
|
||||
/coverage
|
||||
/.next/
|
||||
/out/
|
||||
/build
|
||||
*.tsbuildinfo
|
||||
|
||||
# misc
|
||||
.DS_Store
|
||||
*.pem
|
||||
/.pnp
|
||||
.pnp.js
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
|
||||
# others
|
||||
.env*.local
|
||||
.vercel
|
||||
next-env.d.ts
|
55
apps/docs/.vscode/css.json
vendored
@@ -1,55 +0,0 @@
|
||||
{
|
||||
"version": 1.1,
|
||||
"atDirectives": [
|
||||
{
|
||||
"name": "@tailwind",
|
||||
"description": "Use the `@tailwind` directive to insert Tailwind's `base`, `components`, `utilities` and `screens` styles into your CSS.",
|
||||
"references": [
|
||||
{
|
||||
"name": "Tailwind Documentation",
|
||||
"url": "https://tailwindcss.com/docs/functions-and-directives#tailwind"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "@apply",
|
||||
"description": "Use the `@apply` directive to inline any existing utility classes into your own custom CSS. This is useful when you find a common utility pattern in your HTML that you’d like to extract to a new component.",
|
||||
"references": [
|
||||
{
|
||||
"name": "Tailwind Documentation",
|
||||
"url": "https://tailwindcss.com/docs/functions-and-directives#apply"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "@responsive",
|
||||
"description": "You can generate responsive variants of your own classes by wrapping their definitions in the `@responsive` directive:\n```css\n@responsive {\n .alert {\n background-color: #E53E3E;\n }\n}\n```\n",
|
||||
"references": [
|
||||
{
|
||||
"name": "Tailwind Documentation",
|
||||
"url": "https://tailwindcss.com/docs/functions-and-directives#responsive"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "@screen",
|
||||
"description": "The `@screen` directive allows you to create media queries that reference your breakpoints by **name** instead of duplicating their values in your own CSS:\n```css\n@screen sm {\n /* ... */\n}\n```\n…gets transformed into this:\n```css\n@media (min-width: 640px) {\n /* ... */\n}\n```\n",
|
||||
"references": [
|
||||
{
|
||||
"name": "Tailwind Documentation",
|
||||
"url": "https://tailwindcss.com/docs/functions-and-directives#screen"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "@variants",
|
||||
"description": "Generate `hover`, `focus`, `active` and other **variants** of your own utilities by wrapping their definitions in the `@variants` directive:\n```css\n@variants hover, focus {\n .btn-brand {\n background-color: #3182CE;\n }\n}\n```\n",
|
||||
"references": [
|
||||
{
|
||||
"name": "Tailwind Documentation",
|
||||
"url": "https://tailwindcss.com/docs/functions-and-directives#variants"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
10
apps/docs/.vscode/extensions.json
vendored
@@ -1,10 +0,0 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"dbaeumer.vscode-eslint",
|
||||
"bradlc.vscode-tailwindcss"
|
||||
],
|
||||
|
||||
"unwantedRecommendations": [
|
||||
"esbenp.prettier-vscode"
|
||||
]
|
||||
}
|
51
apps/docs/.vscode/settings.json
vendored
@@ -1,51 +0,0 @@
|
||||
{
|
||||
"eslint.workingDirectories": [
|
||||
{ "pattern": "apps/*/" },
|
||||
{ "pattern": "packages/*/" }
|
||||
],
|
||||
|
||||
"tailwindCSS.experimental.configFile": {
|
||||
"apps/web/tailwind.config.ts": "apps/web/**"
|
||||
},
|
||||
|
||||
"tailwindCSS.experimental.classRegex": [
|
||||
["cva\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
|
||||
["cn\\(([^)]*)\\)", "[\"'`]([^\"'`]*).*?[\"'`]"],
|
||||
],
|
||||
|
||||
"tailwindCSS.classAttributes": [
|
||||
"class",
|
||||
"className",
|
||||
"tw"
|
||||
],
|
||||
|
||||
"css.customData": [
|
||||
".vscode/css.json"
|
||||
],
|
||||
|
||||
"[javascript]": {
|
||||
"editor.formatOnSave": false,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll.eslint": "explicit"
|
||||
}
|
||||
},
|
||||
|
||||
"[typescript]": {
|
||||
"editor.formatOnSave": false,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll.eslint": "explicit"
|
||||
}
|
||||
},
|
||||
|
||||
"[typescriptreact]": {
|
||||
"editor.formatOnSave": false,
|
||||
"editor.codeActionsOnSave": {
|
||||
"source.fixAll.eslint": "explicit"
|
||||
}
|
||||
},
|
||||
|
||||
"eslint.validate": [
|
||||
"javascript",
|
||||
"typescript"
|
||||
],
|
||||
}
|
26
apps/docs/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# docs-v2
|
||||
|
||||
This is a Next.js application generated with
|
||||
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
|
||||
|
||||
Run development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
yarn dev
|
||||
```
|
||||
|
||||
Open http://localhost:3000 with your browser to see the result.
|
||||
|
||||
## Learn More
|
||||
|
||||
To learn more about Next.js and Fumadocs, take a look at the following
|
||||
resources:
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
|
||||
features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs
|
@@ -1,58 +0,0 @@
|
||||
import { defineConfig } from 'astro/config';
|
||||
import starlight from '@astrojs/starlight';
|
||||
|
||||
export default defineConfig({
|
||||
integrations: [
|
||||
starlight({
|
||||
title: '🌴 Palmr. - Documentation',
|
||||
defaultLocale: 'root',
|
||||
social: {
|
||||
github: 'https://github.com/kyantech/Palmr',
|
||||
openCollective: 'https://github.com/sponsors/kyantech',
|
||||
},
|
||||
sidebar: [
|
||||
{
|
||||
label: 'Introduction',
|
||||
items: [
|
||||
{ label: 'Welcome to Palmr.', link: '/' },
|
||||
{ label: 'Architecture of Palmr.', link: '/core/architecture' },
|
||||
{ label: 'GitHub architecture', link: '/core/github-architecture' },
|
||||
{ label: 'Installation (Docker Compose)', link: '/core/installation' },
|
||||
{ label: 'Manual installation', link: '/core/manual-installation' },
|
||||
{ label: 'API Endpoints', link: '/core/api-docs' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'How to use Palmr.',
|
||||
items: [
|
||||
{ label: 'First login (Admin)', link: '/main/login' },
|
||||
{ label: 'Manage users', link: '/main/manage-users' },
|
||||
{ label: 'Uploading files', link: '/main/upload' },
|
||||
{ label: 'Creating a share', link: '/main/generate-share' },
|
||||
{ label: 'Configuring SMTP', link: '/main/configuring-smtp' },
|
||||
{ label: 'Available languages', link: '/main/available-languages' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Developers',
|
||||
items: [
|
||||
{ label: 'How to contribute', link: '/developers/contribute' },
|
||||
{ label: 'How to open an issue', link: '/developers/open-an-issue' },
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Sponsor this project',
|
||||
items: [
|
||||
{ label: 'Star this project on Github', link: '/sponsor/gh-star' },
|
||||
{ label: 'Github Sponsors', link: '/sponsor/gh-sponsor' },
|
||||
],
|
||||
},
|
||||
],
|
||||
lastUpdated: true,
|
||||
pagination: false,
|
||||
customCss: [
|
||||
'./src/styles/custom.css',
|
||||
],
|
||||
}),
|
||||
],
|
||||
});
|
21
apps/docs/components.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"$schema": "https://ui.shadcn.com/schema.json",
|
||||
"style": "new-york",
|
||||
"rsc": true,
|
||||
"tsx": true,
|
||||
"tailwind": {
|
||||
"config": "",
|
||||
"css": "src/app/global.css",
|
||||
"baseColor": "neutral",
|
||||
"cssVariables": true,
|
||||
"prefix": ""
|
||||
},
|
||||
"aliases": {
|
||||
"components": "@/components",
|
||||
"utils": "@/lib/utils",
|
||||
"ui": "@/components/ui",
|
||||
"lib": "@/lib",
|
||||
"hooks": "@/hooks"
|
||||
},
|
||||
"iconLibrary": "lucide"
|
||||
}
|
@@ -1,9 +1,7 @@
|
||||
---
|
||||
title: Palmr. API Endpoints
|
||||
title: API Endpoints
|
||||
---
|
||||
|
||||
##### Overview of Palmr. API Endpoints
|
||||
|
||||
Palmr. provides a **highly documented and typed API** that can be accessed at:
|
||||
|
||||
- **In a production environment:** `{your_server_domain}/docs`
|
||||
@@ -11,7 +9,7 @@ Palmr. provides a **highly documented and typed API** that can be accessed at:
|
||||
|
||||
The API documentation is powered by **Scalar** ([https://scalar.com](https://scalar.com)), which offers a fully interactive interface for testing all the available requests within Palmr. Below is an example screenshot of the API documentation interface:
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -31,7 +29,7 @@ We recommend using **Scalar** for querying and testing the API because the syste
|
||||
|
||||
If you prefer not to use Scalar or are more comfortable with an alternative tool, a **Swagger-based version** of the documentation is also available.
|
||||
|
||||

|
||||

|
||||
|
||||
You can access it at:
|
||||
|
@@ -7,7 +7,7 @@ title: Architecture of Palmr.
|
||||
|
||||
Understanding the architecture of Palmr. is crucial for both deploying and scaling the application. Below is a diagram illustrating the main components:
|
||||
|
||||

|
||||

|
||||
|
||||
## **Technologies Used**
|
||||
|
@@ -32,7 +32,7 @@ The project uses i18next for internationalization (i18n) support. The language d
|
||||
|
||||
#### 2. Manual Selection
|
||||
|
||||

|
||||

|
||||
|
||||
- Users can manually switch languages through the language selector in the UI
|
||||
- Language preference is saved in the browser's localStorage
|
@@ -18,15 +18,15 @@ Now, let's go through the step-by-step process to configure the **SMTP Server**.
|
||||
|
||||
To access **Settings**, an **ADMIN** user must click on the profile picture in the **header** and select **Settings** from the dropdown menu.
|
||||
|
||||

|
||||

|
||||
|
||||
Once inside the **Settings** panel, click on the **Email** card to expand the SMTP configuration options.
|
||||
|
||||

|
||||

|
||||
|
||||
After expanding the card, the following SMTP configuration fields will appear:
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -34,7 +34,7 @@ After expanding the card, the following SMTP configuration fields will appear:
|
||||
|
||||
The first step is to **enable SMTP** by selecting "Yes" in the **SMTP Enabled** field.
|
||||
|
||||

|
||||

|
||||
|
||||
Once SMTP is enabled, you can configure the other necessary fields:
|
||||
|
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: How to Contribute to the Palmr. Project
|
||||
title: How to Contribute
|
||||
---
|
||||
|
||||
Thank you for your interest in contributing to the **Palmr.** project! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. This guide will walk you through the process of contributing to Palmr.
|
@@ -8,11 +8,11 @@ To create a share in Palmr, the process is very intuitive and self-explanatory.
|
||||
|
||||
On the home page, there is a **"Recent Shares"** section. When no shares have been created yet, this section will appear as follows:
|
||||
|
||||

|
||||

|
||||
|
||||
Since no shares exist yet, you will see a **"Create Share"** button prominently displayed.
|
||||
|
||||

|
||||

|
||||
|
||||
> **Note:** You don’t need to upload files to create a share! Yes, it’s entirely possible to create a share without adding any files. While this might not make sense in every scenario, some users and use cases find this feature highly valuable.
|
||||
|
||||
@@ -20,7 +20,7 @@ As mentioned above, shares in Palmr are created first with their settings, and t
|
||||
|
||||
To create a share, simply click the **"Create Share"** button in the center of the **Recent Shares** section. Doing so will open the following **Create Share** modal:
|
||||
|
||||

|
||||

|
||||
|
||||
Fill in the required information in the modal. The fields **Expiration Date**, **Max Views**, and **Password** are optional but significantly impact how the share functions for recipients:
|
||||
- **Password:** If set, the recipient must enter the correct password to access the share.
|
||||
@@ -40,27 +40,27 @@ Once a share is created, the **Recent Shares** section updates to display a tabl
|
||||
- **Recipients**
|
||||
- **Actions**
|
||||
|
||||

|
||||

|
||||
|
||||
To create additional shares, a **"New Share"** button appears in the upper right corner of the **Recent Shares** section.
|
||||
|
||||

|
||||

|
||||
|
||||
Clicking this button will reopen the **Create Share** modal.
|
||||
|
||||
The **Recent Shares** section displays only the **last 5 shares**. To view all created shares, click the **"View All"** button.
|
||||
|
||||

|
||||

|
||||
|
||||

|
||||

|
||||
|
||||
Clicking this redirects you to the **Shares Management** page.
|
||||
|
||||

|
||||

|
||||
|
||||
Another way to access the **Shares Management** page is by clicking the **"My Shares"** card on the home page.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -70,19 +70,19 @@ The **Shares Management** page is similar to the **Uploads Management** page, bu
|
||||
|
||||
##### Each share has an **Actions** column with the following options:
|
||||
|
||||

|
||||

|
||||
|
||||
## Edit Share
|
||||
|
||||
Clicking the **Edit** button allows you to modify the share details.
|
||||
|
||||

|
||||

|
||||
|
||||
## Manage Files
|
||||
|
||||
Clicking the **Manage Files** button lets you add or remove files from the share.
|
||||
|
||||

|
||||

|
||||
|
||||
## Manage Recipients
|
||||
|
||||
@@ -90,36 +90,36 @@ Clicking the **Manage Recipients** button lets you add or remove recipients for
|
||||
|
||||
> **Note:** Email notifications will only be sent if SMTP settings are properly configured in the system.
|
||||
|
||||

|
||||

|
||||
|
||||
## View Share Details
|
||||
|
||||
Clicking **View Details** lets you see all details of a share.
|
||||
|
||||

|
||||

|
||||
|
||||
## Generate Share Link
|
||||
|
||||
Clicking the **Generate Link** button creates a shareable link, which can be customized.
|
||||
|
||||

|
||||

|
||||
|
||||
Once generated, you can view and copy the link.
|
||||
|
||||

|
||||

|
||||
|
||||
The generated link can be edited or copied from a dropdown menu.
|
||||
|
||||

|
||||

|
||||
|
||||
When the generated link is accessed, the recipient can **view and download** the shared files.
|
||||
|
||||

|
||||

|
||||
|
||||
## Delete Share
|
||||
|
||||
Clicking the **Delete** button allows you to permanently remove a share.
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
@@ -24,7 +24,7 @@ Alternatively, you can search for "Palmr" in the GitHub search bar and click on
|
||||
|
||||
On the Palmr repository page, you'll see a "Sponsor" button at the top right corner of the page. Click this button to proceed.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -35,7 +35,7 @@ GitHub Sponsors allows you to sponsor the project with a **custom amount startin
|
||||
2. Type in the amount you'd like to sponsor (e.g., $1, $5, $10, or any amount you choose).
|
||||
3. Select the billing frequency (monthly or one-time).
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
---
|
@@ -24,7 +24,7 @@ Alternatively, you can search for "Palmr" in the GitHub search bar and click on
|
||||
|
||||
On the Palmr. repository page, you'll see a "Star" button at the top right corner of the page. Click this button to star the repository.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -32,7 +32,7 @@ On the Palmr. repository page, you'll see a "Star" button at the top right corne
|
||||
|
||||
After clicking the "Star" button, the button will change to "Unstar," indicating that the repository has been successfully starred. You can always unstar the repository by clicking the "Unstar" button.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
---
|
@@ -1,8 +1,8 @@
|
||||
---
|
||||
title: Introduction
|
||||
title: Welcome to Palmr.
|
||||
---
|
||||
|
||||

|
||||

|
||||
|
||||
## 🌴 What is **Palmr.** ?
|
||||
___
|
@@ -1,9 +1,8 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Guide to install and run Palmr using Docker Compose
|
||||
title: Installation (Docker Compose)
|
||||
---
|
||||
|
||||
import { Tabs, TabItem } from '@astrojs/starlight/components';
|
||||
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';
|
||||
|
||||
### Quick Start with Default Docker Compose
|
||||
|
||||
@@ -29,12 +28,13 @@ To execute the project using this approach, you need to have **Docker** and **Do
|
||||
|
||||
### Ways to Execute the Startup Script
|
||||
|
||||
First of all, clone the official repository: `https://github.com/kyantech/Palmr.git`
|
||||
First of all, download the relase v1.1.7-beta:
|
||||
[Release version - 1.1.7-beta](https://github.com/kyantech/Palmr/releases/tag/v1.1.7-beta)
|
||||
|
||||
There are two ways to execute the script:
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="1. Using a Makefile">
|
||||
<Tabs items={['Using a Makefile', 'Running the Script Directly']}>
|
||||
<Tab >
|
||||
To use this method, you need to have the `make` command installed on your machine.
|
||||
|
||||
To generate the new `docker-compose.yml` file using a Makefile, run the following command from the project root:
|
||||
@@ -49,8 +49,8 @@ There are two ways to execute the script:
|
||||
- It is configured to run locally via `localhost` and is **not intended for production** or VPS environments.
|
||||
|
||||
After the file is generated, you can modify or adapt it for deployment in other environments.
|
||||
</TabItem>
|
||||
<TabItem label="2. Running the Script Directly">
|
||||
</Tab>
|
||||
<Tab >
|
||||
To generate the `docker-compose.yml` file by running the script directly, use the following commands:
|
||||
|
||||
```bash
|
||||
@@ -59,7 +59,7 @@ There are two ways to execute the script:
|
||||
```
|
||||
|
||||
This will have the same effect as running `make gen-compose`.
|
||||
</TabItem>
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
---
|
@@ -9,7 +9,7 @@ Once you have started all the services as described in the deployment instructio
|
||||
|
||||
Upon accessing the frontend, you will see a screen similar to the image below:
|
||||
|
||||

|
||||

|
||||
|
||||
This is the **Palmr. landing page**, which provides basic information about the application. This landing page can be hidden later when you configure your app, allowing the login page to become the default home page. However, on the first execution, it is displayed by default.
|
||||
|
||||
@@ -25,7 +25,7 @@ To simplify the process, Palmr. comes pre-configured with **seed data** upon the
|
||||
|
||||
After clicking the **Login** button, you will be redirected to the login screen, which looks like this:
|
||||
|
||||

|
||||

|
||||
|
||||
Use the following default credentials to log in for the first time:
|
||||
|
||||
@@ -35,7 +35,7 @@ Use the following default credentials to log in for the first time:
|
||||
|
||||
If everything is set up correctly, you will be authenticated and redirected to Palmr.'s main dashboard, which looks like this:
|
||||
|
||||

|
||||

|
||||
|
||||
At this point, you are officially logged in and ready to start using all the features of Palmr.!
|
||||
|
||||
@@ -51,11 +51,11 @@ Follow these steps to update the admin credentials and secure your Palmr. instan
|
||||
1. Click the **user icon** located in the top right corner of the screen.
|
||||
2. A dropdown menu will appear with several options:
|
||||
|
||||

|
||||

|
||||
|
||||
3. Select **"Profile"** from the dropdown menu. This will redirect you to the profile settings page:
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -78,7 +78,7 @@ You can also update the profile picture for better personalization.
|
||||
1. Click the **camera icon** next to the avatar.
|
||||
2. Select an image from your local device.
|
||||
|
||||

|
||||

|
||||
|
||||
> **Recommendation:** Use a square image to ensure proper display.
|
||||
|
@@ -2,9 +2,8 @@
|
||||
title: Manage users
|
||||
---
|
||||
|
||||
##### Manage users to **Palmr** is a straightforward process. Below is a detailed step-by-step guide explaining how to create and manage users within the application.
|
||||
Manage users to **Palmr** is a straightforward process. Below is a detailed step-by-step guide explaining how to create and manage users within the application.
|
||||
|
||||
---
|
||||
|
||||
### Step 1: Accessing User Management
|
||||
|
||||
@@ -13,7 +12,7 @@ To begin, you need to navigate to the **User Management** section:
|
||||
1. Click on the **user icon** located in the header of the app.
|
||||
2. A dropdown menu will appear. From the options available, select **"User Management"**
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -25,7 +24,7 @@ After selecting **User Management**, you will be redirected to the **User Manage
|
||||
- If you need to update the Admin user details, you must follow the steps outlined in the **Profile Management** section.
|
||||
- User details for the logged-in Admin cannot be modified from the **User Management Dashboard**.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -33,18 +32,18 @@ After selecting **User Management**, you will be redirected to the **User Manage
|
||||
|
||||
1. To add a new user, click on the **"Add User"** button located at the top right corner of the screen.
|
||||
|
||||

|
||||

|
||||
|
||||
2. A modal form will appear, allowing you to enter the new user's details:
|
||||
|
||||

|
||||

|
||||
|
||||
3. After filling in the user details, click on **"Create"** to confirm.
|
||||
Alternatively, you can click **"Cancel"** to abort the user creation process.
|
||||
|
||||
4. Once the user is created successfully, it will appear in the user list.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -52,7 +51,7 @@ After selecting **User Management**, you will be redirected to the **User Manage
|
||||
|
||||
In the **User List**, under the **"Actions"** column, you will find a dropdown menu for each user.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
Available actions include:
|
||||
@@ -61,7 +60,7 @@ Available actions include:
|
||||
- Change user details including role.
|
||||
- Change the user password.
|
||||
|
||||

|
||||

|
||||
|
||||
- **Deactivate User** – Marks the user as inactive, preventing them from logging into the system.
|
||||
- **Activate User** – Reactivates a deactivated user, allowing them to log in again.
|
28
apps/docs/content/docs/1.1.7-beta/meta.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"title": "v1.1.7-beta",
|
||||
"description": "(Deprecated)",
|
||||
"root": true,
|
||||
"icon": "Building2",
|
||||
"pages": [
|
||||
"---Introduction---",
|
||||
"index",
|
||||
"architecture",
|
||||
"github-architecture",
|
||||
"installation",
|
||||
"manual-installation",
|
||||
"api",
|
||||
"---How to use Palmr.---",
|
||||
"login",
|
||||
"manage-users",
|
||||
"upload",
|
||||
"generate-share",
|
||||
"configuring-smtp",
|
||||
"available-languages",
|
||||
"---Developers---",
|
||||
"contribute",
|
||||
"open-an-issue",
|
||||
"---Sponsor this project---",
|
||||
"gh-star",
|
||||
"gh-sponsor"
|
||||
]
|
||||
}
|
@@ -24,7 +24,7 @@ Alternatively, you can search for "Palmr" in the GitHub search bar and click on
|
||||
|
||||
On the Palmr repository page, click on the **Issues** tab near the top of the page. This will take you to the issues section of the repository.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
---
|
||||
@@ -33,7 +33,7 @@ On the Palmr repository page, click on the **Issues** tab near the top of the pa
|
||||
|
||||
Once you're in the issues section, click the **New Issue** button to start creating a new issue.
|
||||
|
||||

|
||||

|
||||
|
||||
|
||||
---
|
||||
@@ -47,7 +47,7 @@ You’ll now see a form where you can provide details about your issue. Here’s
|
||||
3. **Labels (Optional)**: Add labels to categorize your issue (e.g., `bug`, `enhancement`, `question`). This helps the maintainers organize and prioritize issues.
|
||||
4. **Attachments (Optional)**: You can attach screenshots, logs, or other files to help explain the issue.
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
@@ -17,36 +17,36 @@ Now let's focus on the file upload process. As mentioned, it is very simple, and
|
||||
On the home page, there is a **"Recent Uploads"** section. On the first initialization (when no file has been uploaded yet),
|
||||
it will appear like this:
|
||||
|
||||

|
||||

|
||||
|
||||
To upload a file, simply click on the **"Upload File"** button. This will open a modal where you can select the file you want
|
||||
to upload from your device. Some file types, such as images, audio, and video, will have a preview available.
|
||||
|
||||

|
||||

|
||||
|
||||
### Example with an image:
|
||||

|
||||

|
||||
|
||||
After selecting the file, you can either confirm the upload by clicking the **"Upload"** button or cancel the operation by clicking the **"Cancel"** button.
|
||||
|
||||

|
||||

|
||||
|
||||
Once one or more files have been uploaded, the **"Recent Uploads"** section will update and look like this:
|
||||
|
||||

|
||||

|
||||
|
||||
To upload a new file from this screen, click the **"Upload File"** button in the upper right corner of the section, and follow the same steps as before.
|
||||
|
||||

|
||||

|
||||
|
||||
This list on the home page shows only the **last 5 uploads**. To view older files or upload more, you need to go to the **"My Files"** page.
|
||||
You can access this by clicking on the **"View All"** button in the upper right corner of the section or by clicking on the **"My Files"** card on the home page.
|
||||
|
||||

|
||||

|
||||
|
||||
Or:
|
||||
|
||||

|
||||

|
||||
|
||||
---
|
||||
|
||||
@@ -54,7 +54,7 @@ Or:
|
||||
|
||||
On the **"My Files"** page, the layout will look like this:
|
||||
|
||||

|
||||

|
||||
|
||||
Here, you have the option to **filter** your uploaded files or upload new ones by clicking the **"Upload File"** button and following the same steps explained earlier.
|
||||
|
||||
@@ -72,13 +72,13 @@ The table fields include:
|
||||
### Actions Column
|
||||
In the **"Actions"** column, you will find an icon that opens the following dropdown:
|
||||
|
||||

|
||||

|
||||
|
||||
Each option is self-explanatory, but let’s detail the **Edit** option:
|
||||
|
||||
- **Edit** – Opens a modal where you can edit the file name, description, and other details.
|
||||
|
||||

|
||||

|
||||
|
||||
- You can also **delete** a file directly from the dropdown by selecting the **Delete** option.
|
||||
|
48
apps/docs/content/docs/2.0.0-beta/api.mdx
Normal file
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: 🔌 API Endpoints
|
||||
tag: v2.0.0-beta
|
||||
---
|
||||
|
||||
## 📚 Accessing the API Documentation
|
||||
|
||||
Palmr. provides a **comprehensive, well-documented, and fully typed API** that has been carefully designed to ensure maximum developer productivity and ease of integration.
|
||||
|
||||
### 🎯 Scalar-Based Documentation
|
||||
|
||||
This API can be accessed through dedicated documentation endpoints at:
|
||||
|
||||
- **In a production environment:** `{your_server_domain}/docs` or `{your_server_ip}/docs`
|
||||
- **In a local environment:** http://localhost:3333/docs
|
||||
|
||||
The API documentation is powered by **[Scalar](https://scalar.com/)**, which provides developers with a sophisticated and fully interactive interface for exploring, testing, and validating all available requests within the Palmr. ecosystem. This modern documentation platform enables real-time testing and visualization of API responses. Below is an example screenshot of the API documentation interface:
|
||||
|
||||

|
||||
|
||||
|
||||
We have made a deliberate decision to **not provide an online version** of the API documentation, as the endpoints and functionality may vary significantly depending on the specific version of Palmr. you have deployed in your environment. To ensure you're always working with accurate and version-specific documentation, we strongly recommend accessing the documentation only after initializing your API service. It's important to note that the API service is specifically designated as the **server** component within the official Palmr. GitHub repository.
|
||||
|
||||
We strongly recommend utilizing **Scalar** as your primary tool for querying and testing the API, as the entire documentation system has been carefully optimized and designed with Scalar integration in mind. Scalar provides developers with an exceptionally intuitive and feature-rich interactive environment that streamlines the process of exploring endpoints, constructing and sending requests, and analyzing responses directly within its sophisticated interface.
|
||||
|
||||
---
|
||||
|
||||
### 🔄 Swagger-Based Documentation
|
||||
|
||||
Understanding that developers may have different preferences or requirements, we also maintain a **Swagger-based version** of the documentation for those who prefer this widely-adopted documentation standard or require compatibility with existing tools and workflows.
|
||||
|
||||

|
||||
|
||||
This alternative documentation format can be accessed at the following endpoints:
|
||||
|
||||
- **In a production environment:** `{your_server_domain}/swagger` or `{your_server_ip}/swagger`
|
||||
- **In a local environment:** http://localhost:3333/swagger
|
||||
|
||||
Rest assured that both the Scalar and Swagger documentation versions maintain complete parity in terms of endpoint coverage and provide equally comprehensive documentation levels, ensuring successful testing and system integration regardless of your chosen documentation platform.
|
||||
|
||||
These carefully curated documentation options have been implemented to ensure that developers have access to all the necessary resources, detailed information, and interactive tools required for seamless integration between Palmr. and both internal systems and third-party services.
|
||||
|
||||
### 🔗 Useful Links
|
||||
|
||||
For additional information and detailed documentation about the tools that power our API documentation, please refer to these official resources:
|
||||
|
||||
- [Scalar Official Website](https://scalar.com/)
|
||||
- [Swagger Official Website](https://swagger.io/)
|
62
apps/docs/content/docs/2.0.0-beta/architecture.mdx
Normal file
@@ -0,0 +1,62 @@
|
||||
---
|
||||
title: 🏗 Architecture of Palmr.
|
||||
---
|
||||
|
||||
## 🔍 Overview
|
||||
|
||||
Understanding the architecture of Palmr. is crucial for both deploying and scaling the application. Below is a diagram illustrating the main components:
|
||||
|
||||

|
||||
|
||||
## 🛠 Technologies Used
|
||||
|
||||
Each component in the Palmr. architecture plays a vital role in ensuring reliability, performance, and scalability. The stack is built with simplicity, performance, and flexibility in mind, everything is self-hosted, developer-friendly, and designed to scale without adding unnecessary complexity.
|
||||
|
||||
|
||||
### 💾 PostgreSQL
|
||||
Palmr. uses **PostgreSQL** as the primary database solution. It's a powerful, open-source relational database that’s trusted by developers around the world. PostgreSQL is fully ACID-compliant, which means it handles transactions safely and reliably. It’s perfect for storing structured data like user accounts, file metadata, transfer logs, and anything else that requires consistency. With advanced features like full-text search, custom data types (like JSONB), and strong indexing capabilities, PostgreSQL gives us the tools to scale efficiently without giving up query performance or flexibility.
|
||||
|
||||
- Provides reliable and secure data storage, ensuring consistency and high performance for all database operations.
|
||||
- Powerful indexing, query optimization, and support for complex data types.
|
||||
- Ideal for handling large amounts of metadata and transactional data in a predictable and scalable way.
|
||||
|
||||
|
||||
### 🎨 Next.js 15 + React + TypeScript
|
||||
The frontend of Palmr. is built using **Next.js 15**, along with **React** and **TypeScript**, forming a modern stack that’s easy to maintain and super fast for end users. Next.js 15 brings server components, server actions, and a new app router system that makes rendering dynamic content incredibly efficient. This allows us to load only what’s needed, when it’s needed which makes the app feel snappy even under load. React provides a clean, component-based structure that makes it easy to break the UI into reusable pieces, and TypeScript helps prevent bugs before they even happen by enforcing static typing and better code navigation. Whether it's SSR, static pages, or dynamic user interactions, this trio handles it all seamlessly.
|
||||
|
||||
- **React** enables the creation of a dynamic and responsive user interface with a component-based architecture.
|
||||
- **TypeScript** adds static typing, enhancing code quality and reducing runtime errors.
|
||||
- **Next.js 15** handles routing, server-side rendering, and server components for performance at scale.
|
||||
|
||||
|
||||
### 📦 MinIO
|
||||
Palmr. uses **MinIO** for object storage. MinIO is a lightweight, high-performance, S3-compatible storage solution that makes file handling simple and scalable. Every file uploaded to Palmr. Whether it's a personal file transfer or a shared asset is stored in MinIO. It’s built to handle huge amounts of data and can be deployed locally, on-premise, or in the cloud. Because it speaks the same API as Amazon S3, integrating with it is straightforward and familiar to most developers. And since it’s self-hosted, we have full control over performance, redundancy, and security.
|
||||
|
||||
- Supports high-throughput file storage and retrieval.
|
||||
- Ensures data integrity and redundancy.
|
||||
- Compatible with AWS S3 APIs, making integration seamless.
|
||||
|
||||
|
||||
### ⚡ Fastify
|
||||
The backend of Palmr. is powered by **Fastify**, a super-fast Node.js web framework optimized for performance and low overhead. It’s designed to handle lots of concurrent requests with minimal resource usage, which is key for scalable backend services. Fastify also has a built-in schema validation system that ensures all incoming data is properly validated before reaching business logic, which helps prevent bugs and security issues. It follows a plugin-based architecture, making it easy to keep route handlers, services, and middlewares cleanly separated and easy to extend as the project grows.
|
||||
|
||||
- Provides fast request handling with a lightweight core.
|
||||
- Built-in schema-based validation for secure and reliable API handling.
|
||||
- Supports plugin-based architecture for easy extensibility.
|
||||
|
||||
|
||||
### 🔄 How It Works
|
||||
1. **Frontend** — React + TypeScript + Next.js 15 handle the user interface and user interactions.
|
||||
2. **Backend** — Fastify processes requests and communicates with the database and storage layers.
|
||||
3. **Database** — PostgreSQL stores metadata and transactional data.
|
||||
4. **Object Storage** — MinIO stores the actual files and ensures scalable, high-performance storage.
|
||||
|
||||
|
||||
### 📚 Useful Links
|
||||
- [PostgreSQL Documentation](https://www.postgresql.org/docs/)
|
||||
- [Next.js Documentation](https://nextjs.org/docs)
|
||||
- [React Documentation](https://react.dev/)
|
||||
- [TypeScript Handbook](https://www.typescriptlang.org/docs/)
|
||||
- [MinIO Documentation](https://min.io/docs/minio/container/index.html)
|
||||
- [Fastify Documentation](https://fastify.dev/docs/latest/)
|
||||
|
52
apps/docs/content/docs/2.0.0-beta/available-languages.mdx
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: 🌐 Available languages
|
||||
---
|
||||
|
||||
The project leverages next-intl, a powerful and flexible internationalization (i18n) library, to provide comprehensive language support across the entire application. This robust solution enables seamless translation management, date/time formatting, number formatting, and pluralization rules across different locales. The integration of next-intl ensures consistent internationalization throughout the application's components, pages, and features, while maintaining optimal performance through efficient bundle splitting and lazy loading of language resources. With its TypeScript support and React Server Components compatibility, next-intl serves as the foundation for delivering a truly global and accessible user experience.
|
||||
|
||||
## 🗣️ Available Languages in Palmr.
|
||||
|
||||
---
|
||||
|
||||
| Language | Code | Description | Translation |
|
||||
|----------|------|-------------|-------------|
|
||||
| 🇺🇸 English | en-US | Primary development language and default fallback option | 100% |
|
||||
| 🇧🇷 Portuguese | pt-BR | Standard Brazilian Portuguese support | 100% |
|
||||
| 🇫🇷 French | fr-FR | Standard French language support | 100% |
|
||||
| 🇪🇸 Spanish | es-ES | Standard Spanish language support | 100% |
|
||||
| 🇩🇪 German | de-DE | Standard German language support | 100% |
|
||||
| 🇷🇺 Russian | ru-RU | Standard Russian language support | 100% |
|
||||
| 🇮🇳 Hindi | hi-IN | Standard Hindi language support | 100% |
|
||||
| 🇸🇦 Arabic | ar-SA | Standard Arabic language support with RTL | 100% |
|
||||
| 🇯🇵 Japanese | ja-JP | Standard Japanese language support | 100% |
|
||||
| 🇰🇷 Korean | ko-KR | Standard Korean language support | 100% |
|
||||
| 🇹🇷 Turkish | tr-TR | Standard Turkish language support | 100% |
|
||||
| 🇨🇳 Chinese | zh-CN | Standard Simplified Chinese support | 100% |
|
||||
|
||||
### 🔄 Language Selection
|
||||
|
||||
The application provides two convenient methods for language selection, ensuring a seamless user experience:
|
||||
|
||||
### 🤖 1. Automatic Detection
|
||||
|
||||
- The application features sophisticated automatic detection of the user's preferred browser language settings
|
||||
- Intelligently utilizes the browser's preconfigured language preferences to set the initial application language
|
||||
|
||||
### 👆 2. Manual Selection
|
||||
|
||||

|
||||
|
||||
- Users have complete control to manually select their preferred language through an intuitive language selector interface in the UI
|
||||
- Selected language preferences are persistently stored in the browser's localStorage for a consistent experience across sessions
|
||||
|
||||
### ⭐ Default Language
|
||||
|
||||
English (en-US) serves as the system's fallback language, ensuring consistent functionality even when language detection or selection encounters issues. This means that if a user's preferred language is not available or if there are any problems with language selection, the application will automatically default to English. This fallback mechanism is crucial for maintaining a seamless user experience and preventing any potential language-related disruptions. Additionally, all new features and updates are first implemented in English before being translated into other supported languages, ensuring that the English version always remains the most up-to-date and comprehensive.
|
||||
|
||||
### 🔍 Language Detection
|
||||
|
||||
The application employs advanced detection mechanisms to automatically identify and apply the user's browser language settings as the initial language configuration. For maximum flexibility, users can easily override this selection at any time using the convenient language switcher, accessible via the globe icon prominently displayed in the navigation bar.
|
||||
|
||||
### ↔️ RTL Support
|
||||
|
||||
The application incorporates comprehensive right-to-left (RTL) text handling capabilities, with particular attention paid to Arabic (ar-SA) language requirements, ensuring proper text alignment, layout direction, and user interface elements.
|
67
apps/docs/content/docs/2.0.0-beta/configuring-smtp.mdx
Normal file
@@ -0,0 +1,67 @@
|
||||
---
|
||||
title: ✉️ Configuring SMTP
|
||||
---
|
||||
|
||||
For Palmr to function with all its best features, we need to configure our email server. To make this easier, there is a built-in configuration panel inside **Settings** in Palmr. However, only users with an **ADMIN** profile can access and configure these settings.
|
||||
|
||||
## ❓ Why Configure SMTP?
|
||||
|
||||
The main functionalities that depend on SMTP configuration are:
|
||||
- 🔑 **Password Reset** – Users who forget their password and cannot access the **Settings** panel need this feature.
|
||||
- 📧 **Email Notifications** – Recipients will receive emails when new shares are sent to them.
|
||||
|
||||
Now, let's go through the step-by-step process to configure the **SMTP Server**.
|
||||
|
||||
---
|
||||
|
||||
### 🔧 Accessing SMTP Settings
|
||||
|
||||
To access **Settings**, an **ADMIN** user must click on the profile picture in the **header** and select **Settings** from the dropdown menu.
|
||||
|
||||

|
||||
|
||||
Once inside the **Settings** panel, click on the **Email** card to expand the SMTP configuration options.
|
||||
|
||||

|
||||
|
||||
After expanding the card, the following SMTP configuration fields will appear:
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Configuring SMTP Server
|
||||
|
||||
The first step is to **enable SMTP** by selecting "Yes" in the **SMTP Enabled** field.
|
||||
|
||||

|
||||
|
||||
Once SMTP is enabled, you can configure the other necessary fields:
|
||||
|
||||
- **Sender Name** – This will appear as the sender’s name in emails. (Example: "Palmr")
|
||||
- **Sender Email** – The email address from which notifications will be sent. (Example: "noreply@palmr.app")
|
||||
- **SMTP Server** – The SMTP server address. You can use any email service provider. For Gmail, use `smtp.gmail.com` (this is the recommended option and set as default).
|
||||
- **SMTP Port** – The server port. For Gmail, the standard port is **587**.
|
||||
- **SMTP Username** – The username for the SMTP server. For Gmail, enter your email address.
|
||||
- **SMTP Password** – The SMTP password. (Generate an App Password for Gmail)
|
||||
|
||||
> **Important:** If using **Gmail**, you need to generate an **App Password** instead of using your standard email password.
|
||||
> For other email services, consult the official documentation of the service provider you are using. We recommend using Gmail for simplicity and limits the number of emails sent.
|
||||
|
||||
---
|
||||
|
||||
### 🔐 Generating a Gmail App Password
|
||||
|
||||
To generate an App Password for Gmail:
|
||||
1. Go to [Google My Account](https://myaccount.google.com/).
|
||||
2. Select **Security**.
|
||||
3. Scroll down to **App Passwords**.
|
||||
4. Generate a new password specifically for Palmr.
|
||||
|
||||
For a complete guide, refer to: **[How to set up SMTP credentials with Gmail](https://medium.com/rails-to-rescue/how-to-set-up-smtp-credentials-with-gmail-for-your-app-send-email-cf236d11087d)**.
|
||||
|
||||
---
|
||||
|
||||
### ✅ Finalizing SMTP Configuration
|
||||
|
||||
After entering the correct information, save the settings. Palmr is now ready to send emails for password resets and share notifications!
|
217
apps/docs/content/docs/2.0.0-beta/contribute.mdx
Normal file
@@ -0,0 +1,217 @@
|
||||
---
|
||||
title: 🤝 How to Contribute
|
||||
---
|
||||
|
||||
## 👋 Introduction
|
||||
|
||||
Thank you for your interest in contributing to the **Palmr.** project! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Whether you're fixing bugs, adding new features, improving documentation, or sharing ideas, every contribution helps make Palmr better for everyone. We welcome contributors of all experience levels - from beginners to seasoned developers. This comprehensive guide will walk you through the process of contributing to Palmr, from setting up your development environment to submitting your first pull request. We're excited to have you join our community of contributors!
|
||||
|
||||
---
|
||||
|
||||
### 🔑 GitHub Login
|
||||
|
||||
Before you can contribute, you need to be logged into your GitHub account. If you don't have an account yet, you can sign up for free at **[GitHub](https://github.com/)**. Having a GitHub account is essential as it allows you to fork repositories, submit pull requests, and interact with other contributors. Make sure to use a professional email address when creating your account, and consider enabling two-factor authentication for enhanced security. Once your account is set up, you can customize your profile and start exploring the vast open-source community on GitHub.
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Access the Repository
|
||||
Once you're logged in, go to the Palmr repository by clicking on this link: **[https://github.com/kyantech/Palmr](https://github.com/kyantech/Palmr)**. The repository contains all the source code, documentation, and resources for the Palmr project. Take a moment to explore the repository structure, including the README file, which provides an overview of the project.
|
||||
|
||||
Alternatively, you can search for "Palmr" in the GitHub search bar and click on the repository owned by **kyantech**. When searching, make sure you're looking at the official repository by checking the owner and repository name. The repository should have a description that matches the Palmr project and show recent activity from the maintainers. You can also check the number of stars, forks, and watchers to verify you're accessing the correct repository.
|
||||
|
||||
---
|
||||
|
||||
### 🍴 Fork the Repository
|
||||
|
||||
To contribute to the project, you'll need to create your own copy of the repository. This is called a **fork**. Here's how to do it:
|
||||
|
||||
1. Click the **Fork** button at the top right of the repository page.
|
||||
2. Select where you want to fork the repository (your personal account or an organization).
|
||||
3. Wait a few moments while GitHub creates your fork.
|
||||
4. This will create a copy of the repository under your GitHub account.
|
||||
5. You'll be automatically redirected to your forked repository once it's ready.
|
||||
|
||||
The fork will maintain a connection to the original repository, allowing you to:
|
||||
- Keep your fork synchronized with the original repository
|
||||
- Submit pull requests from your fork to the original repository
|
||||
- Work independently on your own copy without affecting the original
|
||||
|
||||
---
|
||||
|
||||
### 📥 Clone the Fork
|
||||
|
||||
Next, you’ll need to clone your forked repository to your local machine. Here’s how:
|
||||
1. On your forked repository page, click the **Code** button.
|
||||
2. Copy the repository URL (HTTPS or SSH).
|
||||
3. Open your terminal or command prompt and run the following command to clone the repository:
|
||||
|
||||
```bash
|
||||
git clone <repository-url>
|
||||
```
|
||||
|
||||
4. Navigate into the cloned directory:
|
||||
|
||||
```bash
|
||||
cd Palmr
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔄 Set up Base Branch
|
||||
|
||||
Before making changes, ensure your local repository is set up to track the `next` branch from the original Palmr repository. Here’s how:
|
||||
1. Add the original Palmr repository as a remote:
|
||||
|
||||
```bash
|
||||
git remote add upstream https://github.com/kyantech/Palmr.git
|
||||
```
|
||||
|
||||
2. Fetch the latest changes from the `next` branch:
|
||||
|
||||
```bash
|
||||
git fetch upstream next
|
||||
```
|
||||
|
||||
3. Create a new branch for your contribution based on `upstream/next`:
|
||||
|
||||
```bash
|
||||
git checkout -b your-branch-name upstream/next
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### ✏️ Make Local Changes
|
||||
Now you're ready to make your contributions! This could include:
|
||||
- Fixing a bug
|
||||
- Adding a new feature
|
||||
- Improving documentation
|
||||
- Writing tests
|
||||
- Enhancing performance
|
||||
- Adding translations
|
||||
- Improving accessibility
|
||||
- Refactoring code
|
||||
- Adding examples
|
||||
- Reporting issues
|
||||
|
||||
Make your changes in your local repository using your preferred code editor. Here are some tips for making changes:
|
||||
|
||||
1. **Follow the Style Guide**: Make sure your code follows the project's coding standards and style guidelines
|
||||
2. **Test Your Changes**: Run tests locally to ensure your changes don't break existing functionality
|
||||
3. **Keep Changes Focused**: Make small, focused changes that address a single issue or feature
|
||||
4. **Document Your Changes**: Add or update documentation as needed to explain your changes
|
||||
5. **Review Your Work**: Double-check your changes before committing to ensure quality
|
||||
|
||||
Remember to regularly save your work and test your changes incrementally to catch any issues early in the development process.
|
||||
|
||||
---
|
||||
|
||||
### 📝 Use Conventional Commits
|
||||
|
||||
Once you’ve made your changes, commit them to your branch using **Conventional Commits**. Conventional Commits help maintain a clean and consistent commit history. Here’s how to format your commit messages:
|
||||
|
||||
**Commit Message Format:**
|
||||
`<type>(<scope>): <description>`
|
||||
|
||||
**Examples:**
|
||||
- `feat: add user authentication`
|
||||
- `fix(api): resolve null pointer exception`
|
||||
- `docs: update README file`
|
||||
- `chore: update dependencies`
|
||||
|
||||
**Steps to Commit:**
|
||||
1. Stage your changes:
|
||||
|
||||
```bash
|
||||
git add .
|
||||
```
|
||||
|
||||
2. Commit your changes with a properly formatted message:
|
||||
|
||||
```bash
|
||||
git commit -m "feat: add new feature for user profiles"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 📤 Push Changes
|
||||
|
||||
After committing your changes, you'll need to push them to your forked repository on GitHub. This step synchronizes your local changes with your remote repository. Here's how to do it:
|
||||
|
||||
1. First, ensure your branch is up-to-date with any remote changes:
|
||||
```bash
|
||||
git pull origin your-branch-name
|
||||
```
|
||||
|
||||
2. Then push your commits to your forked repository:
|
||||
```bash
|
||||
git push origin your-branch-name
|
||||
```
|
||||
|
||||
If this is the first time pushing this branch, you might need to set the upstream branch:
|
||||
```bash
|
||||
git push -u origin your-branch-name
|
||||
```
|
||||
|
||||
If you encounter any errors while pushing:
|
||||
- Make sure you have the correct permissions on your fork
|
||||
- Verify your remote URL is correct using `git remote -v`
|
||||
- Check if you need to authenticate with GitHub
|
||||
|
||||
---
|
||||
|
||||
### 🔀 Create Pull Request
|
||||
|
||||
Now that your changes are on GitHub, you can open a **Pull Request (PR)** to propose your changes to the `next` branch of the Palmr repository. Here’s how:
|
||||
1. Go to your forked repository on GitHub.
|
||||
2. Click the **Pull Request** button.
|
||||
3. On the PR creation page:
|
||||
- Set the **base repository** to `kyantech/Palmr`.
|
||||
- Set the **base branch** to `next`.
|
||||
- Set the **head repository** to your forked repository.
|
||||
- Set the **compare branch** to your branch (`your-branch-name`).
|
||||
4. Fill out the PR form with a clear title and description of your changes.
|
||||
5. Click **Create Pull Request**.
|
||||
|
||||
---
|
||||
|
||||
### ⏳ Await Review
|
||||
|
||||
Once your PR is submitted, the maintainers will review your changes. They may provide feedback or request additional changes. During this process:
|
||||
|
||||
- **Monitor Your PR**: Keep an eye on GitHub notifications for any comments or requests
|
||||
- **Be Responsive**: Try to address feedback promptly and professionally
|
||||
- **Make Updates**: If changes are requested, update your branch and push the new commits
|
||||
- **Ask Questions**: Don't hesitate to ask for clarification if needed
|
||||
- **Be Patient**: The review process may take some time depending on maintainer availability
|
||||
|
||||
Remember that code review is a collaborative process aimed at ensuring code quality. Stay engaged and maintain open communication with the maintainers throughout the review process.
|
||||
|
||||
---
|
||||
|
||||
## 💡 Contribution Tips
|
||||
|
||||
To ensure your contribution is accepted, follow these tips:
|
||||
- **Use Conventional Commits**: Write clear and consistent commit messages using the Conventional Commits format.
|
||||
- **Keep Your PRs Small**: Focus on one issue or feature per PR to make it easier to review.
|
||||
- **Be Patient**: Maintainers are often volunteers and may take some time to review your PR.
|
||||
- **Write Tests**: Include tests for any new features or bug fixes you implement.
|
||||
- **Follow Code Style**: Adhere to the project's coding standards and style guidelines.
|
||||
- **Update Documentation**: Keep documentation in sync with code changes.
|
||||
- **Engage in Discussion**: Participate in PR discussions and be open to feedback.
|
||||
- **Review Others' PRs**: Help the community by reviewing other contributors' pull requests.
|
||||
- **Stay Updated**: Keep your fork synchronized with the main repository.
|
||||
|
||||
---
|
||||
|
||||
## ⭐ Why Contribute?
|
||||
|
||||
Contributing to open-source projects like Palmr has many benefits:
|
||||
1. **Improves the Project**: Your contributions help make the project better for everyone.
|
||||
2. **Builds Your Skills**: You’ll gain experience working with Git, GitHub, and collaborative coding.
|
||||
3. **Supports the Community**: Open-source thrives on community contributions. Your work helps sustain the project.
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Final Words
|
||||
|
||||
That's it! You've successfully contributed to the **🌴 Palmr.** project on GitHub. Thank you for your time and effort in making Palmr better for everyone. We appreciate your contribution!
|
152
apps/docs/content/docs/2.0.0-beta/generate-share.mdx
Normal file
@@ -0,0 +1,152 @@
|
||||
---
|
||||
title: 🔗 Managing shares
|
||||
---
|
||||
|
||||
## 📤 Creating a share
|
||||
|
||||
Creating a share in Palmr is designed to be a straightforward and user-friendly experience that anyone can master quickly. While the platform offers several methods for share creation, we recommend beginning with the most accessible approach: utilizing the **Home Page**, particularly through the well-organized **Recent Shares** section.
|
||||
|
||||
___
|
||||
|
||||
### Home Page
|
||||
|
||||
When you visit the home page, you'll immediately notice the **"Recent Shares"** section, which serves as your central hub for file sharing. For new users who haven't created any shares yet, this section presents a clean, welcoming interface as follows:
|
||||
|
||||

|
||||
|
||||
For first-time users, the interface features a prominently positioned **"Create Share"** button that stands out against the clean background, making it impossible to miss.
|
||||
|
||||

|
||||
|
||||
> Note: One of Palmr's unique features is its flexibility - you don't need to upload files to create a share! This might seem counterintuitive at first, but it's a deliberately designed feature that many users find invaluable for their specific workflows and use cases. This approach allows you to set up the sharing framework first and add content later.
|
||||
>
|
||||
|
||||
This design philosophy reflects Palmr's user-centric approach: you can establish your share's parameters and settings first, then populate it with files at your convenience. Furthermore, all aspects of your share remain fully editable at any time, providing maximum flexibility.
|
||||
|
||||
To initiate the share creation process, locate and click the **"Create Share"** button positioned centrally within the **Recent Shares** section. This action will trigger the appearance of a comprehensive **Create Share** modal window:
|
||||
|
||||

|
||||
|
||||
Within the modal, you'll find various fields to customize your share. While some fields are optional, they each serve important functions in controlling how your share behaves. Pay particular attention to these three powerful security options - **Expiration Date**, **Max Views**, and **Password** - as they significantly enhance your control over how recipients interact with your shared content:
|
||||
|
||||
- **Password:** Adding this extra layer of security ensures that only recipients with the correct password can gain access to your shared content, providing an additional verification step.
|
||||
- **Max Views:** This feature allows you to set a specific limit on the number of times your share can be accessed. Once this threshold is reached, the share becomes inaccessible unless you, as the creator, choose to adjust or remove the viewing limit.
|
||||
- **Expiration Date:** By setting this parameter, you can determine precisely how long your share remains accessible. After the specified date passes, the share automatically deactivates, though you retain the ability to extend this deadline if needed.
|
||||
|
||||
While the **name** field isn't mandatory, we strongly encourage users to assign meaningful names to their shares for easier management and organization of multiple shares over time.
|
||||
|
||||
After successfully creating a share, the **Recent Shares** section transforms into an informative table display, presenting comprehensive details through the following columns:
|
||||
|
||||
- **Name**
|
||||
- **Created At**
|
||||
- **Expires At**
|
||||
- **Status**
|
||||
- **Security**
|
||||
- **Files**
|
||||
- **Recipients**
|
||||
- **Actions**
|
||||
|
||||

|
||||
|
||||
For your convenience, once you've created your first share, a **"New Share"** button appears in the upper right corner of the **Recent Shares** section, making it easy to create additional shares.
|
||||
|
||||

|
||||
|
||||
This conveniently positioned button provides quick access to the **Create Share** modal whenever you need to create another share.
|
||||
|
||||
To maintain a clean and manageable interface, the **Recent Shares** section displays your **last 5 shares** by default. When you need to access your complete sharing history, simply click the **"View All"** button to see your entire collection of shares.
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||
Upon clicking this button, you'll be seamlessly redirected to the comprehensive **Shares Management** page.
|
||||
|
||||

|
||||
|
||||
For quick access to your complete share collection, you can also reach the **Shares Management** page by clicking the conveniently placed **"My Shares"** card on the home page.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### 📊 Shares Management Page
|
||||
|
||||
The **Shares Management** page functions similarly to the **Uploads Management** page but offers expanded capabilities. Here, you'll find a complete overview where you can **add, remove, edit, and view all created shares** without being restricted to the five-share limit of the Recent Shares section.
|
||||
|
||||
Each share has an **Actions** column with the following options:
|
||||
|
||||

|
||||
|
||||
___
|
||||
|
||||
## ✏️ Edit Share
|
||||
|
||||
The **Edit** button provides access to a comprehensive interface where you can modify and update all share details as needed.
|
||||
|
||||

|
||||
|
||||
## 📁 Manage Files
|
||||
|
||||
___
|
||||
|
||||
Through the **Manage Files** button, you gain complete control over the content of your share, with the ability to both add new files and remove existing ones.
|
||||
|
||||

|
||||
|
||||
___
|
||||
|
||||
## 👥 Manage Recipients
|
||||
|
||||
The **Manage Recipients** button opens an interface where you can maintain your recipient list, adding or removing access as needed.
|
||||
|
||||
> Note: For email notifications to function properly, please ensure that your system's SMTP settings are correctly configured and active.
|
||||
>
|
||||
|
||||

|
||||
|
||||
___
|
||||
|
||||
## 👀 View Share Details
|
||||
|
||||
The **View Details** option provides a comprehensive overview of all aspects and settings associated with your share.
|
||||
|
||||

|
||||
|
||||
___
|
||||
|
||||
## 🔗 Generate Share Link
|
||||
|
||||
The **Generate Link** feature allows you to create a customizable sharing link for easy distribution of your content.
|
||||
|
||||

|
||||
|
||||
After generation, the system presents you with the link for immediate viewing and copying.
|
||||
|
||||

|
||||
|
||||
A convenient dropdown menu provides options to either edit the generated link's settings or copy it to your clipboard.
|
||||
|
||||

|
||||
|
||||
When recipients access your generated link, they'll be able to both **view and download** the shared files according to the permissions you've set.
|
||||
|
||||

|
||||
|
||||
___
|
||||
|
||||
## Delete Share
|
||||
|
||||
Clicking the
|
||||
|
||||
**Delete**
|
||||
|
||||
button allows you to permanently remove any share that's no longer needed.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### 📝 Summary
|
||||
|
||||
Palmr's share creation system exemplifies intuitive design and flexible functionality. The platform offers comprehensive features including file-free share creation, customizable share settings, recipient management, and secure link generation. The dedicated **Shares Management** page serves as your command center, providing complete oversight and control of your entire sharing ecosystem.
|
110
apps/docs/content/docs/2.0.0-beta/gh-sponsor.mdx
Normal file
@@ -0,0 +1,110 @@
|
||||
---
|
||||
title: 💝 Github Sponsors
|
||||
---
|
||||
|
||||
## 👋 Introduction
|
||||
|
||||
Sponsoring a project on GitHub is a powerful way to support its development and ensure its long-term sustainability. This tutorial will guide you through the process of sponsoring the **Palmr.** project on GitHub using GitHub Sponsors.
|
||||
|
||||
By becoming a sponsor, you'll not only help maintain and improve the project, but you'll also:
|
||||
|
||||
- Support continuous development and bug fixes
|
||||
- Enable new feature implementations
|
||||
- Help cover hosting and infrastructure costs
|
||||
- Show appreciation for the developers' hard work
|
||||
- Join a community of supporters who value open source
|
||||
|
||||
---
|
||||
|
||||
### 🔑 GitHub Login
|
||||
|
||||
Before you can sponsor a project, you need to be logged into your GitHub account. If you don't have an account yet, you can sign up for free at [GitHub](https://github.com/). Having an account also allows you to:
|
||||
|
||||
- Follow project updates
|
||||
- Report issues
|
||||
- Contribute to discussions
|
||||
- Access sponsor-only content (if available)
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Access the Repository
|
||||
|
||||
Once you're logged in, go to the Palmr. repository by clicking on this link: [https://github.com/kyantech/Palmr](https://github.com/kyantech/Palmr).
|
||||
|
||||
Alternatively, you can search for "Palmr" in the GitHub search bar and click on the repository owned by **Kyantech**.
|
||||
|
||||
You can also:
|
||||
- Star the repository to show your support
|
||||
- Watch it for updates
|
||||
- Fork it if you want to contribute
|
||||
|
||||
---
|
||||
|
||||
### 💖 Click the Sponsor Button
|
||||
|
||||
On the Palmr repository page, you'll see a **Sponsor** button at the top right corner of the page. Click this button to proceed. The button is typically highlighted in a distinct color to make it easily visible.
|
||||
|
||||

|
||||
|
||||
Pro tip: You can also access the sponsorship page directly through your GitHub dashboard under "Sponsoring" if you've sponsored us before.
|
||||
|
||||
---
|
||||
|
||||
### 💰 Choose a Custom Sponsorship
|
||||
|
||||
GitHub Sponsors allows you to sponsor the project with a **custom amount starting at $1**:
|
||||
|
||||
1. On the sponsorship page, look for the option to **enter a custom amount**.
|
||||
2. Type in the amount you'd like to sponsor (e.g., $1, $5, $10, or any amount you choose).
|
||||
3. Select the billing frequency (**monthly** or **one-time**).
|
||||
4. Consider setting up automatic annual sponsorship for a simplified experience.
|
||||
5. Look for any special tier benefits that might be available at different sponsorship levels.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### ✅ Complete Your Sponsorship
|
||||
|
||||
After entering your custom amount and selecting the billing frequency, you'll be prompted to enter your payment details. Follow the instructions to complete the sponsorship process.
|
||||
|
||||
Once done, you'll officially be a **Palmr sponsor**! 🙌
|
||||
|
||||
---
|
||||
|
||||
### ⭐ Why Sponsoring Matters
|
||||
|
||||
- 🧱 Supports Sustainability
|
||||
Your sponsorship helps keep the project alive and maintained long-term.
|
||||
|
||||
- 🚀 Encourages Innovation
|
||||
Financial support gives developers the freedom to try new ideas and push boundaries.
|
||||
|
||||
- 🫶 Shows Deep Appreciation
|
||||
Sponsoring is a meaningful, tangible way to thank developers for their work.
|
||||
|
||||
- 🏆 Earns You Recognition
|
||||
Many projects publicly thank their sponsors — you might appear in the README or on the site!
|
||||
|
||||
- 🌱 Helps Open Source Thrive
|
||||
Open-source projects rely on community support. Sponsoring helps the ecosystem grow.
|
||||
|
||||
---
|
||||
|
||||
## 🎁 What Happens After Sponsoring
|
||||
|
||||
Once you become a sponsor:
|
||||
1. You'll receive a confirmation email from GitHub
|
||||
2. Your name will appear in our sponsors list
|
||||
3. You'll get access to sponsor-only updates and content
|
||||
4. You'll be invited to our private Discord channel
|
||||
5. You'll receive early access to new features
|
||||
|
||||
---
|
||||
|
||||
## 🌟 Final Words
|
||||
|
||||
That's it! You've successfully sponsored the **Palmr.** project on GitHub.
|
||||
Your support will help ensure this open-source project continues to evolve and thrive.
|
||||
**We appreciate you and welcome you to our community!** 🎉
|
||||
|
127
apps/docs/content/docs/2.0.0-beta/gh-star.mdx
Normal file
@@ -0,0 +1,127 @@
|
||||
---
|
||||
title: ⭐ Star on Github
|
||||
---
|
||||
|
||||
## 👋 Introduction
|
||||
|
||||
Starring a project on GitHub is a great way to show appreciation for a repository and to bookmark it for easy access later. This tutorial will guide you through the process of starring the **Palmr** project on GitHub. By starring our repository, you help increase its visibility and support the ongoing development of the project.
|
||||
|
||||
---
|
||||
|
||||
### 🔑 GitHub Login
|
||||
|
||||
Before you can star a project, you need to be logged into your GitHub account. If you don't have an account yet, you can sign up for free at [GitHub](https://github.com/). Here's how to get started:
|
||||
|
||||
1. Visit [GitHub's signup page](https://github.com/signup)
|
||||
2. Enter your email address
|
||||
3. Create a strong password
|
||||
4. Choose a username
|
||||
5. Complete the verification process
|
||||
6. Select your preferences and complete the setup
|
||||
|
||||
Once your account is created, make sure to verify your email address to access all GitHub features.
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Access the Repository
|
||||
|
||||
There are several ways to find and access the Palmr repository:
|
||||
|
||||
1. **Direct Link**: Go to the Palmr repository by clicking on this link: [https://github.com/kyantech/Palmr](https://github.com/kyantech/Palmr)
|
||||
|
||||
2. **Search Method**:
|
||||
- Go to GitHub's main page
|
||||
- Click the search bar at the top
|
||||
- Type "Palmr"
|
||||
- Look for the repository owned by **Kyantech**
|
||||
- Click on the repository name to access it
|
||||
|
||||
3. **Through Profile**:
|
||||
- Visit Kyantech's GitHub profile
|
||||
- Navigate to the "Repositories" tab
|
||||
- Find and click on "Palmr"
|
||||
|
||||
---
|
||||
|
||||
### 🌟 Find the Star Button
|
||||
|
||||
Once you're on the Palmr repository page, you'll find the "Star" button in the top-right section of the page. Here's what to look for:
|
||||
|
||||
1. Look at the top navigation bar of the repository
|
||||
2. Find the row of action buttons (Watch, Fork, Star)
|
||||
3. The Star button will be prominently displayed with a star icon ⭐
|
||||
4. You may see the current star count next to the button
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### ✅ Confirm the Star
|
||||
|
||||
After clicking the "Star" button, several things will happen:
|
||||
|
||||
1. The button will change from "Star" to "Unstar"
|
||||
2. The star count will increase by one
|
||||
3. The button will fill with color to indicate it's active
|
||||
4. The repository will be added to your starred repositories list
|
||||
|
||||
You can access your starred repositories anytime by:
|
||||
- Clicking your profile picture
|
||||
- Selecting "Your stars" from the dropdown menu
|
||||
- Or visiting: https://github.com/[your-username]?tab=stars
|
||||
|
||||
To remove your star, simply click the "Unstar" button at any time.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### 💫 Why Starring Matters
|
||||
|
||||
Starring a repository on GitHub is more than just a bookmarking tool—it’s a way to support the project and its developers. Here’s why starring is so important:
|
||||
|
||||
- 🙌 Shows Appreciation
|
||||
Starring a repository is a simple way to show your appreciation for the hard work and effort that goes into maintaining and developing a project.
|
||||
|
||||
- 📈 Increases Visibility
|
||||
The more stars a repository has, the more visible it becomes on GitHub.
|
||||
|
||||
- 💪 Encourages Developers
|
||||
Seeing stars motivates developers to continue improving the project.
|
||||
|
||||
- 🔍 Helps with Discovery
|
||||
GitHub prioritizes repositories with more stars in trending and recommendations.
|
||||
|
||||
- 📚 Tracks Your Interests
|
||||
Starred repositories are saved to your list for easy access later.
|
||||
|
||||
- 🌍 Supports Open Source
|
||||
Your stars help sustain the open-source community and the Palmr project.
|
||||
|
||||
---
|
||||
|
||||
## 💝 Small Action / Big Impact
|
||||
|
||||
Starring a repository takes just a second, but it can have a huge impact on the project's growth and development. Here's what your star means to us:
|
||||
|
||||
- Helps drive project momentum
|
||||
- Encourages more community participation
|
||||
- Provides valuable feedback on project value
|
||||
- Helps us set and achieve development goals
|
||||
- Supports sustainable open-source development
|
||||
|
||||
Your star is more than just a number - it's a vote of confidence in our vision and helps shape the future of Palmr.
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Final Words
|
||||
|
||||
That's it! You've successfully starred the **Palmr** project on GitHub. Thank you for supporting Palmr and becoming part of our growing community! Your support helps us continue improving and expanding the project for everyone.
|
||||
|
||||
Feel free to explore our other ways to contribute, like:
|
||||
- Sharing Palmr with others
|
||||
- Reporting issues
|
||||
- Contributing code
|
||||
- Joining discussions
|
||||
|
||||
Every interaction helps make Palmr. better!
|
145
apps/docs/content/docs/2.0.0-beta/github-architecture.mdx
Normal file
@@ -0,0 +1,145 @@
|
||||
---
|
||||
title: </> Github Architecture
|
||||
---
|
||||
|
||||
import { File, Folder, Files } from "fumadocs-ui/components/files";
|
||||
|
||||
## Project Structure
|
||||
|
||||
<Files>
|
||||
<Folder name="apps" defaultOpen>
|
||||
<Folder name="docs" >
|
||||
<File name="all documentation files" />
|
||||
</Folder>
|
||||
<Folder name="server" >
|
||||
<File name="all backend files" />
|
||||
</Folder>
|
||||
<Folder name="web" >
|
||||
<File name="all frontend files" />
|
||||
</Folder>
|
||||
</Folder>
|
||||
<File name="other project files" />
|
||||
</Files>
|
||||
|
||||
|
||||
## Core Components
|
||||
|
||||
### 🖥️ Frontend Application (apps/web)
|
||||
|
||||
**Technology Stack:**
|
||||
|
||||
- Next.js 15 (App Router)
|
||||
- React 18
|
||||
- TypeScript
|
||||
- TailwindCSS
|
||||
- shadcn/ui components
|
||||
- next-intl for internationalization
|
||||
|
||||
Palmr.'s frontend is built with **Next.js 15**, using the App Router and Server Components for performance, scalability, and flexibility. The structure is modular and feature-based, keeping things easy to evolve as the product grows. UI logic runs on **React 18**, and **TypeScript** adds type safety that prevents a lot of silent bugs. Styles are handled with **TailwindCSS**, letting us build clean, responsive interfaces quickly. For components, we rely on **shadcn/ui**, a headless component library built with Radix UI and Tailwind, it’s fast, accessible, and fully customizable.
|
||||
|
||||
Internationalization is handled by **next-intl**, which integrates perfectly with Next.js routing. It supports locale-aware routes, per-page translation loading, and plural rules, all without any extra client-side bloat. It’s flexible, lightweight, and great for apps with multilingual audiences.
|
||||
|
||||
The frontend is organized with:
|
||||
|
||||
- A **components-based architecture** for modular UI
|
||||
- **Custom hooks** to isolate logic and side effects
|
||||
- A **route protection system** using session cookies and middleware
|
||||
- A **file management interface** integrated with the backend
|
||||
- A **reusable modal system** used for file actions, confirmations, and more
|
||||
- **Dynamic, locale-aware routing** using next-intl
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Backend Service (apps/server)
|
||||
|
||||
**Technology Stack:**
|
||||
|
||||
- Fastify
|
||||
- PostgreSQL
|
||||
- MinIO (S3-compatible)
|
||||
- Prisma ORM
|
||||
|
||||
The backend is built on **Fastify**, a blazing-fast web framework for Node.js. It’s lightweight, modular, and optimized for high performance. Every route is validated using JSON schema, which helps keep the API consistent and secure. Auth flows are built using JWTs stored in HTTP-only cookies, and everything from file uploads to token-based sharing goes through this layer.
|
||||
|
||||
Data is stored in **PostgreSQL**, which handles user info, file metadata, session tokens, and more. For actual file storage, we use **MinIO**, a fast, S3-compatible object store that’s self-hosted and super scalable. It’s perfect for keeping user files isolated and safe. We use **Prisma** as our ORM to simplify database access, it gives us type-safe queries and easy-to-read code.
|
||||
|
||||
Key features include:
|
||||
|
||||
- **Authentication/authorization** with JWT + cookie sessions
|
||||
- **File management logic** including uploads, deletes, and renames
|
||||
- **Storage operations** to handle bucket creation, usage tracking, and cleanup
|
||||
- A **share system** that generates tokenized public file links
|
||||
- Schema-based request validation for all endpoints
|
||||
- Prisma models that keep the database logic predictable and type-safe
|
||||
|
||||
---
|
||||
|
||||
### 📚 Documentation (apps/docs)
|
||||
|
||||
**Technology Stack:**
|
||||
|
||||
- Fumadocs
|
||||
- MDX (Markdown + JSX)
|
||||
- React-based components
|
||||
|
||||
The docs are built using **Fumadocs**, a modern documentation system built on top of Next.js. It uses **MDX**, so you can mix Markdown with interactive React components, perfect for developer tools and open-source projects. Pages are fast, versionable, and easy to customize. The goal is to keep the documentation as close to the codebase as possible, using shared components where needed and reusing UI patterns directly from the app.
|
||||
|
||||
It supports sidebar navigation, keyboard shortcuts, dark mode, and even interactive demos or UI previews. The file tree you see above, for example, is powered by a real React component from the docs.
|
||||
|
||||
- Built with **Fumadocs**, powered by Next.js
|
||||
- Supports **MDX** and full React component embedding
|
||||
- Ideal for technical docs and live code samples
|
||||
- Styled using the same Tailwind setup from the main app
|
||||
|
||||
---
|
||||
|
||||
### 🏗️ Infrastructure
|
||||
|
||||
Palmr. is fully containerized using **Docker**, which means every service: frontend, backend, database, storage, runs in its own isolated environment. With `docker-compose`, the whole stack spins up locally with a single command. It’s also easy to deploy to services like Fly.io, Render, or your own VPS.
|
||||
|
||||
Volumes are used to persist data locally, and containers are networked together so that all services can talk to each other securely.
|
||||
|
||||
- **Docker-first architecture** with all services containerized
|
||||
- Configurable through `.env` and compose overrides
|
||||
- Local volumes and named networks
|
||||
- Easy to deploy and scale on any container-compatible infra
|
||||
|
||||
---
|
||||
|
||||
## Key Features
|
||||
|
||||
### 📂 File Management
|
||||
|
||||
Files are at the heart of Palmr. Users can upload files via the frontend, and they’re streamed directly to MinIO. The backend handles metadata (name, size, type, ownership), and also handles deletion, renaming, and public sharing. Every file operation is tracked, and all actions can be scoped per user.
|
||||
|
||||
- Upload/download with instant feedback
|
||||
- File previews, type validation, and size limits
|
||||
- Token-based sharing system
|
||||
- Disk usage tracking by user
|
||||
|
||||
### 👤 User System
|
||||
|
||||
Authentication is done through secure JWTs, stored in HTTP-only cookies for safety. Signup and login flows are simple and fast, and user info is kept in sync across the frontend and backend.
|
||||
|
||||
- Cookie-based session management
|
||||
- Role support and future admin access
|
||||
- Profile updates and password reset flows
|
||||
- Logged-in user state handled via custom hooks
|
||||
|
||||
### 💾 Storage System
|
||||
|
||||
MinIO is used for all file storage. It’s fast, lightweight, and fully S3-compatible which means it can scale easily and integrates with tons of other tools. The backend tracks usage, handles cleanup of orphaned files, and ensures that every file on disk has a matching database record.
|
||||
|
||||
- S3-compatible object storage via MinIO
|
||||
- Upload validation and automatic cleanup
|
||||
- Usage tracking and quotas (per user or global)
|
||||
- Secure access to stored files with signed URLs
|
||||
|
||||
### 🌐 Internationalization
|
||||
|
||||
Palmr. supports multiple languages using **next-intl**, which is deeply integrated into the routing system. It loads only the necessary translations per route, supports nested namespaces, and makes it easy to keep things organized even at scale.
|
||||
|
||||
- Per-locale localstorage (`en-US`, `pt-BR`, etc.)
|
||||
- Translation loading by namespace/page
|
||||
- Full pluralization and formatting support
|
||||
- Easy translation management via JSON files
|
52
apps/docs/content/docs/2.0.0-beta/index.mdx
Normal file
@@ -0,0 +1,52 @@
|
||||
---
|
||||
title: 🌴 Welcome to Palmr.
|
||||
---
|
||||
|
||||

|
||||
|
||||
**Palmr.** is a powerful and **flexible open-source alternative** to popular file transfer services like **WeTransfer**, **SendGB**, **Send Anywhere** and **Files.fm**. The key advantage of Palmr. is that you can **host it on your own infrastructure**, such as a **dedicated server** or **VPS**, giving you full control over your files and data security without relying on third-party services or worrying about artificial limits or high fees.
|
||||
|
||||
## **Why Choose Palmr.?**
|
||||
|
||||
### 🚫 **No Artificial Limits**
|
||||
|
||||
Unlike traditional file transfer services that impose arbitrary restrictions, Palmr. takes a fundamentally different approach by removing all artificial constraints on file sizes and quantities. The only practical limitation you'll encounter is the **available storage** space on your server or VPS infrastructure. This means that as long as you have adequate storage capacity in your hosting environment, you have complete freedom to transfer files of any size and in any quantity. There are no premium tiers to unlock additional features, no intrusive advertisements to navigate around, and absolutely no hidden charges or unexpected fees that might surprise you later. This unrestricted approach ensures that your file transfer capabilities are determined solely by your infrastructure choices rather than arbitrary service limitations.
|
||||
|
||||
### 🌟 **Open Source and Free**
|
||||
|
||||
Palmr. is completely **open source** and free to use, which means there are no licensing fees, subscription costs, or hidden charges associated with implementing and maintaining the software. This commitment to open source principles ensures complete transparency and freedom in how you utilize the platform. You can:
|
||||
|
||||
- Deploy it on any infrastructure of your choice (VPS, dedicated server, Docker, cloud platforms, or other hosting environments), giving you complete flexibility in your hosting decisions.
|
||||
- Review and audit the entire codebase to ensure security and integrity, allowing you to verify that the software meets your organization's security standards and compliance requirements.
|
||||
- Contribute improvements or custom features to enhance the platform's functionality, participating in the collaborative development process that makes open source software so powerful.
|
||||
- Adapt it for different use cases as needed, whether you're using it for personal file sharing, business operations, or specialized applications that require custom modifications.
|
||||
|
||||
### 🔒 **Security and Privacy Under Your Control**
|
||||
|
||||
When you host Palmr. on your infrastructure, you maintain **full control over your data** through end-to-end management of the storage and transfer process. By keeping files within your own hosting environment, you eliminate security vulnerabilities that could arise from third-party handling. Your files never get stored or processed by external services, ensuring complete **privacy** and **confidentiality** of transferred information. This allows you to implement security protocols and compliance measures that match your specific requirements.
|
||||
|
||||
By eliminating third-party involvement, you gain peace of mind knowing that the files are never handled by external providers. This guarantees that you retain full control over data handling and processing, reinforcing the confidentiality of sensitive information throughout its lifecycle.
|
||||
|
||||
With Palmr., your security and privacy are entirely in your hands, making it a powerful and reliable solution for organizations that require full control over their data, whether for internal use or for compliance with regulations.
|
||||
|
||||
### 🎨 **Highly Customizable**
|
||||
|
||||
Palmr. offers extensive customization options that allow you to tailor every aspect of the platform to perfectly align with your brand identity and create an optimal user experience that matches your specific requirements:
|
||||
|
||||
- Add your own **logo** to maintain consistent branding across your file-sharing platform and establish a professional, unified presence.
|
||||
- Set a **custom app name** that reflects your organization's identity and helps users instantly recognize your branded file-sharing solution.
|
||||
- Configure an **SMTP server** for email notifications, enabling seamless communication with users about file transfers, updates, and system alerts.
|
||||
- Customize text throughout the interface to create a unique user experience that resonates with your audience and maintains your brand voice.
|
||||
|
||||
### 👥 **Complete User and Admin Management**
|
||||
|
||||
Palmr. provides a comprehensive and sophisticated user and admin management system that puts you in complete control of your file-sharing environment:
|
||||
|
||||
- Create and manage multiple **administrators** with different permission levels to ensure proper oversight and delegation of responsibilities.
|
||||
- Add unlimited **users** to accommodate teams of any size, from small workgroups to large enterprises.
|
||||
- Control who can view, upload, and manage files with granular permission settings that allow you to implement precise access controls.
|
||||
- Easily monitor storage usage through detailed analytics and reporting tools that help you optimize resource allocation.
|
||||
|
||||
### ⚡ **Fast, Lightweight, and Scalable**
|
||||
|
||||
Palmr. demonstrates exceptional technical capabilities through its streamlined and expandable architecture, engineered to deliver optimal operational efficiency. The system effectively processes substantial file transfers and manages high-volume user activity while consistently maintaining superior transfer rates. The platform's contemporary infrastructure automatically adjusts to accommodate increased utilization, facilitating uninterrupted functionality as operational requirements expand. Through advanced resource allocation and refined programming, the system delivers a highly responsive user experience that accommodates organizational growth while maintaining consistent performance standards and operational stability.
|
264
apps/docs/content/docs/2.0.0-beta/installation.mdx
Normal file
@@ -0,0 +1,264 @@
|
||||
---
|
||||
title: 🐳 Installation (Docker Compose)
|
||||
---
|
||||
|
||||
|
||||
Installation via Docker Compose is the simplest way to run the project across different environments. For it to run correctly, we need two main tools installed in our environment:
|
||||
|
||||
- Docker ([https://docs.docker.com](https://docs.docker.com/))
|
||||
- Docker Compose ([https://docs.docker.com/compose](https://docs.docker.com/compose/))
|
||||
|
||||
> *It's worth emphasizing that Palmr. was fully developed in a MacOS environment and extensively tested on Linux servers. Therefore, we can guarantee the best system performance in these environments. Windows and other environments have not been tested yet, and potential bugs may occur during execution. However, remember that we are still in a beta version of Palmr., and errors or bugs can occur in any operating system. If you identify any issues, we appreciate your help in notifying us through our GitHub [issues page](https://github.com/kyantech/Palmr/issues).*
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quick Start
|
||||
|
||||
Having installed [Docker](https://docs.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) in our environment, we can proceed with the simple installation using these tools.
|
||||
|
||||
In the root folder of our project, we can find our `docker-compose.yaml` file, which is the only file needed to run the project via Docker and Docker Compose. This is because the pre-built images are already in our [DockerHub](https://hub.docker.com/repositories/kyantech) and are only referenced in the `docker-compose.yaml`
|
||||
|
||||
Any changes needed for execution can be made directly in our `docker-compose.yaml` or via environment variables, which we will show later in this tutorial.
|
||||
|
||||
Next, let's look at the content of our `docker-compose.yaml`.
|
||||
|
||||
---
|
||||
|
||||
## 🐳 Docker Compose Content
|
||||
Below is the complete content of our `docker-compose.yaml` that can be copied directly from here or from our official repository ([Docker Compose](https://github.com/kyantech/Palmr/blob/main/docker-compose.yaml)).
|
||||
|
||||
```yaml
|
||||
services:
|
||||
palmr-api:
|
||||
image: kyantech/palmr-api:v2.0.0-beta # Make sure to use the correct version (latest) of the image
|
||||
container_name: palmr-api
|
||||
depends_on:
|
||||
postgres:
|
||||
condition: "service_healthy"
|
||||
minio:
|
||||
condition: "service_healthy"
|
||||
environment:
|
||||
- PORT=${API_INTERNAL_PORT:-3333} # Port for the backend service
|
||||
- DATABASE_URL=postgresql://postgres:${POSTGRES_PASSWORD:-postgresRootPassword}@postgres:5432/palmr_db?schema=public # Database URL with configurable password through POSTGRES_PASSWORD env var
|
||||
- MINIO_ENDPOINT=minio # This can change if your MinIO is at a different address
|
||||
- MINIO_PORT=${MINIO_INTERNAL_API_PORT:-6421} # Default MinIO port (Change if yours is not the default)
|
||||
- MINIO_USE_SSL=false # MinIO uses SSL by default, but you can change it to true if needed
|
||||
- MINIO_ROOT_USER=${MINIO_ROOT_USER:-minio_root_user} # MinIO credentials can be configured through MINIO_ROOT_USER env vars
|
||||
- MINIO_ROOT_PASSWORD=${MINIO_ROOT_PASSWORD:-minioRootPassword} # MinIO credentials can be configured through MINIO_ROOT_PASSWORD env vars
|
||||
- MINIO_REGION=sa-east-1 # MinIO region - This is needed for MinIO to work properly
|
||||
- MINIO_BUCKET_NAME=files # MinIO bucket name - This is needed for MinIO to work properly, dont change it if you don't know what you are doing
|
||||
- FRONTEND_URL=${APP_URL:-http://${SERVER_IP:-localhost}:${APP_EXTERNAL_PORT:-5487}} # Frontend URL - Make sure to use the correct frontend URL, depends on where the frontend is running, its prepared for localhost, but you can change it to your frontend URL if needed
|
||||
- SERVER_IP=${SERVER_IP:-localhost} # Server IP - Make sure to use the correct server IP if you running on a cloud provider or a virtual machine. This prepared for localhost, but you can change it to your server IP if needed
|
||||
- MAX_FILESIZE=${MAX_FILESIZE:-1073741824} # Max Filesize for upload - Declared in Bytes. Default is 1GiB
|
||||
ports:
|
||||
- "${API_EXTERNAL_PORT:-3333}:${API_INTERNAL_PORT:-3333}" # Backend port mapping
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:${API_INTERNAL_PORT:-3333}/health"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
start_period: 30s
|
||||
|
||||
palmr-app:
|
||||
image: kyantech/palmr-app:v2.0.0-beta # Make sure to use the correct version (latest) of the image
|
||||
container_name: palmr-web
|
||||
depends_on:
|
||||
palmr-api:
|
||||
condition: "service_healthy"
|
||||
ports:
|
||||
- "${APP_EXTERNAL_PORT:-5487}:5487" # Frontend port mapping
|
||||
environment:
|
||||
- NODE_ENV=production
|
||||
- NEXT_TELEMETRY_DISABLED=1
|
||||
- API_BASE_URL=http://palmr-api:${API_INTERNAL_PORT:-3333} # Here we use docker's internal network to reference the backend service (can be changed if needed)
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:5487"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
|
||||
minio:
|
||||
image: minio/minio:RELEASE.2025-03-12T18-04-18Z # Use only version RELEASE.2025-03-12T18-04-18Z to avoid compatibility issues with the backend
|
||||
container_name: minio
|
||||
environment:
|
||||
# MinIO credentials - same as above, configurable through environment variables
|
||||
- MINIO_ROOT_USER=${MINIO_ROOT_USER:-minio_root_user}
|
||||
- MINIO_ROOT_PASSWORD=${MINIO_ROOT_PASSWORD:-minioRootPassword}
|
||||
- MINIO_SITE_REGION=sa-east-1
|
||||
command: server /data --address ":${MINIO_INTERNAL_API_PORT:-6421}" --console-address ":${MINIO_INTERNAL_CONSOLE_PORT:-6422}"
|
||||
volumes:
|
||||
- minio_data:/data
|
||||
ports:
|
||||
- "${MINIO_EXTERNAL_API_PORT:-6421}:${MINIO_INTERNAL_API_PORT:-6421}"
|
||||
- "${MINIO_EXTERNAL_CONSOLE_PORT:-6422}:${MINIO_INTERNAL_CONSOLE_PORT:-6422}"
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "curl", "-f", "http://localhost:${MINIO_INTERNAL_API_PORT:-6421}/minio/health/ready"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
|
||||
minio-init:
|
||||
image: minio/mc:RELEASE.2025-03-12T17-29-24Z # Use only version RELEASE.2025-03-12T17-29-24Z to avoid compatibility issues with the backend and MinIO
|
||||
container_name: minio-init
|
||||
depends_on:
|
||||
minio:
|
||||
condition: "service_healthy"
|
||||
restart: "no"
|
||||
# The entrypoint script will create a bucket called "files" and set it to be publicly readable using the MinIO client (mc).
|
||||
entrypoint: >
|
||||
sh -c "
|
||||
sleep 5 &&
|
||||
mc alias set myminio http://minio:${MINIO_INTERNAL_API_PORT:-6421} ${MINIO_ROOT_USER:-minio_root_user} ${MINIO_ROOT_PASSWORD:-minioRootPassword} &&
|
||||
mc mb myminio/files --ignore-existing &&
|
||||
mc anonymous set download myminio/files
|
||||
"
|
||||
|
||||
postgres:
|
||||
image: bitnami/postgresql:17.2.0 # You can use any postgres version you prefer, but remember that some versions might not be compatible
|
||||
container_name: palmr-postgres
|
||||
environment:
|
||||
# PostgreSQL credentials configurable through environment variables
|
||||
# POSTGRES_USER, POSTGRES_PASSWORD, and POSTGRES_DB can be set to override defaults
|
||||
- POSTGRESQL_USERNAME=${POSTGRES_USER:-postgres}
|
||||
- POSTGRESQL_PASSWORD=${POSTGRES_PASSWORD:-postgresRootPassword}
|
||||
- POSTGRESQL_DATABASE=${POSTGRES_DB:-palmr_db}
|
||||
volumes:
|
||||
- postgres_data:/bitnami/postgresql
|
||||
ports:
|
||||
- "5432:5432"
|
||||
restart: unless-stopped
|
||||
healthcheck:
|
||||
test: ["CMD", "pg_isready", "-U", "palmr"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 5
|
||||
|
||||
volumes:
|
||||
minio_data:
|
||||
postgres_data:
|
||||
|
||||
```
|
||||
|
||||
Notice that the `docker-compose.yaml` has several comments that help you configure your own compose to meet your environment's needs. Let's give an overview of some changes we can make.
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Services Overview
|
||||
|
||||
Palmr. consists of five main services, each with specific responsibilities. Below, we present a detailed view of each component:
|
||||
|
||||
| **Service** | **Image** | **Exposed Ports** | **Main Features** |
|
||||
| --- | --- | --- | --- |
|
||||
| palmr-api (Backend) | [kyantech/palmr-api:latest](https://hub.docker.com/repository/docker/kyantech/palmr-api/tags/latest/sha256-84245d3d0012aa65c588caba56322363729c4b68c3722a08dcda912904de9d1d) | **3333** | • Main API service<br/>• Depends on services: postgres and minio<br/>• Has healthcheck to ensure availability |
|
||||
| palmr-app (Frontend) | [kyantech/palmr-app:latest](https://hub.docker.com/repository/docker/kyantech/palmr-app/tags/latest/sha256-33f568673ae8cc8529532146b6afc1acafa203387ced6c7bb3451a7ab4198a2f) | **5487** | • Web application interface<br/>• Depends on palmr-api service<br/>• Configured for production environment |
|
||||
| minio (Storage) | [minio/minio:RELEASE.2025-03-12T18-04-18Z](https://hub.docker.com/layers/minio/minio/RELEASE.2025-03-12T18-04-18Z/images/sha256-85f3e4cd1ca92a2711553ab79f222bcd8b75aa2c77a1a0b0ccf80d38e8ab2fe5) | **6421**(API)<br/>**6422**(Console) | • File storage service<br/>• Persistent volume for data |
|
||||
| minio-init (Config) | [minio/mc:RELEASE.2025-03-12T17-29-24Z](https://hub.docker.com/layers/minio/mc/RELEASE.2025-03-12T17-29-24Z/images/sha256-68d8c80f43908b02daa285e55547131870a1d36b3ffe272c26d7d8f4d52d1e5c) | N/A | • Initially configures the "files" bucket<br/>• Runs only once during initialization |
|
||||
| postgres (Database) | [bitnami/postgresql:17.2.0](https://hub.docker.com/layers/bitnami/postgresql/17.2.0/images/sha256-29c614afad4f514b12b5c0f4d006f38c98fa4b18c3582732ff93b3fe9a79d875) | **5432** | • PostgreSQL database<br/>• Persistent volume for data |
|
||||
|
||||
---
|
||||
|
||||
### 🛠️ Available Environment Variables
|
||||
|
||||
The table below shows all environment variables that can be set
|
||||
|
||||
| **Variable** | **Default Value** | **Description** |
|
||||
| --- | --- | --- |
|
||||
| API_INTERNAL_PORT | 3333 | Internal API port in container |
|
||||
| API_EXTERNAL_PORT | 3333 | Exposed port on host for API |
|
||||
| POSTGRES_PASSWORD | postgresRootPassword | PostgreSQL database password |
|
||||
| APP_EXTERNAL_PORT | 5487 | Exposed port on host for frontend |
|
||||
| APP_URL | http://localhost:5487 | Complete frontend URL |
|
||||
| SERVER_IP | localhost | IP of the server where the application is running |
|
||||
| MINIO_ROOT_USER | minio_root_user | MinIO admin user |
|
||||
| MINIO_ROOT_PASSWORD | minioRootPassword | MinIO admin password |
|
||||
| MINIO_INTERNAL_API_PORT | 6421 | Internal MinIO API port |
|
||||
| MINIO_INTERNAL_CONSOLE_PORT | 6422 | Internal MinIO console port |
|
||||
| MINIO_EXTERNAL_API_PORT | 6421 | Exposed port on host for MinIO API |
|
||||
| MINIO_EXTERNAL_CONSOLE_PORT | 6422 | Exposed port on host for MinIO console |
|
||||
| POSTGRESQL_USERNAME | postgres | PostgreSQL user |
|
||||
| POSTGRESQL_DATABASE | palmr_db | Database name |
|
||||
| MAX_FILESIZE | 1073741824 | Max Uploadsize per file. Unit in Bytes |
|
||||
|
||||
> *All these variables can be configured through a .env file in the project root or defined directly in the environment where docker-compose will be executed. The best way to do this is up to you. But be careful to replace correctly if doing directly in the compose instead of providing an environment var.*
|
||||
>
|
||||
|
||||
|
||||
#### 🗂️ Persistent Volumes
|
||||
|
||||
- minio_data: Stores MinIO files
|
||||
- postgres_data: Stores PostgreSQL data
|
||||
|
||||
---
|
||||
|
||||
### 💻 Local Execution
|
||||
|
||||
In a localhost environment, there's no mystery. If you don't want to change any service exposure ports, you can simply run:
|
||||
|
||||
This will execute all necessary services and give you access to the following URLs (if you haven't changed any ports):
|
||||
|
||||
- **Frontend:** [http://localhost:5487](http://localhost:5487)
|
||||
- **Backend:** [http://localhost:3333](http://localhost:3333/)
|
||||
- **MinIO API:** [http://localhost:6421](http://localhost:6421)
|
||||
- **MinIO Console:** [http://localhost:6422](http://localhost:6422)
|
||||
- **Postgres Database:** [http://localhost:5423](http://localhost:5423/) (Connection only)
|
||||
|
||||
> *If you have changed any port, simply access the URL with the port you configured.*
|
||||
>
|
||||
|
||||
---
|
||||
|
||||
### 🌐 Production (VPS or other)
|
||||
|
||||
For production environments, whether it's your VPS, Homelab Server, or other, the execution is very similar to the localhost environment, except for some particularities that may occur in some cases.
|
||||
|
||||
We mainly need to pay attention to the following points:
|
||||
|
||||
- Correctly set the `SERVER_IP` env var with our server's IP, otherwise some redirects and queries will fail during App execution.
|
||||
- Set the `APP_URL` - regardless of whether the frontend is on the same server and with the same IP, it's extremely important to set this environment variable, otherwise sharing links will be generated incorrectly.
|
||||
- For all environment variables that are `PASSWORD`, it's highly recommended to generate secure passwords and replace them as env vars.
|
||||
- Lastly, make sure no docker service will conflict with any existing ones in your environment. If there is a conflict, simply change the execution ports via environment var or in the docker compose.
|
||||
|
||||
To generate a .env file with just the `server_ip` configuration, you can run this command:
|
||||
|
||||
```bash
|
||||
curl -fsSL https://gist.githubusercontent.com/danielalves96/5a68913d70e5e31b68b7331dc17dfa9c/raw | bash
|
||||
```
|
||||
> execute this command in your server terminal, at same path of docker-compose.yaml.
|
||||
|
||||
Basically, by paying attention to these points, you can quickly execute the project with the same command we used for localhost:
|
||||
|
||||
```bash
|
||||
docker compose pull && docker compose up -d
|
||||
```
|
||||
|
||||
⚠️ This makes sure you're always running the latest beta version of the image, otherwise, Docker might reuse an outdated one from cache.
|
||||
|
||||
At this stage, if you encounter any errors, it's worth reviewing your `docker-compose.yaml` and trying again, paying close attention to the points mentioned above.
|
||||
|
||||
> *First test without using reverse proxies like Caddy, Traefik, etc... if you plan to use them. Access the services via `server_ip:port` after confirming they work, then make the necessary routing configurations as desired.*
|
||||
>
|
||||
|
||||
If you haven't changed the execution ports, you'll have access on your server at:
|
||||
|
||||
- **Frontend:** `[server_ip]:5487`
|
||||
- **Backend:** `[server_ip]:3333`
|
||||
- **MinIO API:** `[server_ip]:6421`
|
||||
- **MinIO Console:** `[server_ip]:6422`
|
||||
- **Postgres Database:** `[server_ip]:5423` (Connection only)
|
||||
|
||||
> *If you've changed any port, simply access the URL with the port you configured.*
|
||||
>
|
||||
|
||||
It's worth noting that this is just a quick start and we're not going into details about any of the developed services, but it's recommended for execution in any environment. However, if your focus is on using Palmr. with high availability in mind, it's recommended to use a container orchestrator prepared for this, such as Kubernetes or similar, but we don't cover this type of configuration in our documentation.
|
||||
|
||||
---
|
||||
|
||||
## 📚 Additional Resources
|
||||
|
||||
- [Docker Documentation](https://docs.docker.com/)
|
||||
- [Docker Compose Documentation](https://docs.docker.com/compose/)
|
||||
- [MinIO Documentation](https://min.io/docs/minio/container/index.html)
|
||||
- [PostgreSQL Documentation](https://www.postgresql.org/docs/)
|
81
apps/docs/content/docs/2.0.0-beta/manage-users.mdx
Normal file
@@ -0,0 +1,81 @@
|
||||
---
|
||||
title: 👥 Users Management
|
||||
---
|
||||
|
||||
Managing users in **Palmr.** is a straightforward and intuitive process that ensures proper access control and organization within your system. This comprehensive step-by-step guide will walk you through the essential processes of creating, modifying, and managing user accounts within the application.
|
||||
|
||||
## 🔐 Accessing User Management
|
||||
|
||||
To initiate the user management process, you'll need to navigate to the dedicated **User Management** section. This centralized hub provides all the tools necessary for effective user administration:
|
||||
|
||||
1. Locate and click on the **user icon** prominently displayed in the application's header area, where all primary navigation controls are situated.
|
||||
2. Upon clicking, a comprehensive dropdown menu will appear, presenting various options. From these choices, locate and select **"User Management"** to proceed
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### 📊 User Management Dashboard
|
||||
|
||||
Upon selecting **User Management**, the system will automatically direct you to the comprehensive **User Management Dashboard**, your central control panel for all user-related operations.
|
||||
|
||||
- During your initial access to the system, you'll notice that the user list contains only the **default Admin** user account, which serves as the primary administrative account.
|
||||
- Should you find it necessary to modify the Admin user's information or credentials, please note that these changes must be implemented through the dedicated **Profile Management** section, which provides specialized tools for administrator profile maintenance.
|
||||
- For security purposes and to maintain system integrity, it's important to understand that the currently logged-in Admin user's details cannot be altered directly from within the **User Management Dashboard**.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### 👤 Adding a New User
|
||||
|
||||
1. To initiate the process of adding a new user to the system, locate and click the **"Add User"** button, which is conveniently positioned in the top right corner of your screen for easy access.
|
||||
|
||||

|
||||
|
||||
1. Upon clicking, an interactive modal form will be displayed, presenting you with all the necessary fields to input the new user's comprehensive details and access permissions:
|
||||
|
||||

|
||||
|
||||
1. After carefully entering all the required user information and reviewing for accuracy, click the **"Create"** button to finalize the process. ✨ If you need to start over or decide not to proceed, simply click the **"Cancel"** button to terminate the user creation process without saving any changes.
|
||||
2. Following successful user creation, the new account will be immediately visible in the user list, confirming the completion of the process. 🎉
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Managing User Actions
|
||||
|
||||
Within the **User List** interface, you'll find a comprehensive **"Actions"** column containing a dropdown menu for each user account, providing access to all available management functions.
|
||||
|
||||

|
||||
|
||||
The following administrative actions are available for your convenience:
|
||||
|
||||
- 📝 **Edit User** – Provides access to a detailed modal form for comprehensive user information updates:
|
||||
- Modify various user details including their assigned role and permissions within the system.
|
||||
- Implement security measures such as password changes and access control modifications.
|
||||
|
||||

|
||||
|
||||
- 🔒 **Deactivate User** – Temporarily suspends user access by marking the account as inactive, effectively preventing any system login attempts while maintaining their account information.
|
||||
- 🔓 **Activate User** – Restores full system access for previously deactivated users, enabling them to resume normal account activities and authentication.
|
||||
- ❌ **Delete User** – Executes a permanent removal of the user account from the system, including all associated data and permissions.
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Troubleshooting
|
||||
|
||||
In the event of any challenges or issues during the user management process, please refer to the following troubleshooting guidelines:
|
||||
|
||||
### 🚫 User Creation Fails
|
||||
|
||||
- Carefully verify that all required fields (including name, email address, and role assignments) have been completed with accurate information.
|
||||
- Perform a thorough check to ensure the email address isn't already associated with an existing account in the system.
|
||||
- Confirm that your system maintains a stable and active connection to the backend services necessary for user management.
|
||||
|
||||
### 🔑 User Cannot Log In
|
||||
|
||||
- First, verify that the user's account status is set to **Active** in the system.
|
||||
- Double-check that the user is attempting to authenticate with their correct email address and current password combination.
|
||||
- If authentication issues persist, initiate a password reset procedure to establish new credentials.
|
212
apps/docs/content/docs/2.0.0-beta/manual-installation.mdx
Normal file
@@ -0,0 +1,212 @@
|
||||
---
|
||||
title: 📦 Manual Installation
|
||||
---
|
||||
|
||||
Manual installation requires more detailed attention and hands-on configuration compared to the streamlined process offered by Docker Compose. While this approach demands additional effort and technical understanding, following our comprehensive step-by-step guide will ensure a clean and successful project execution with full control over each component.
|
||||
|
||||
An important consideration in this manual setup process is that while we'll be handling the frontend and backend deployments directly, we still require Docker or an equivalent third-party service to manage our Postgres database and MinIO object storage infrastructure. For the purposes of this tutorial, we've chosen to utilize Docker with Docker Compose to establish and configure both MinIO and Postgres, as this provides a reliable and well-tested environment.
|
||||
|
||||
To facilitate this setup, we've included a pre-configured Docker Compose file within the `apps/server` directory that handles the initialization and configuration of both MinIO and Postgres - two essential components for the application's core functionality. While this is our recommended approach, you maintain the flexibility to implement alternative solutions that better suit your specific needs or infrastructure requirements. Our decision to leverage Docker Compose for these particular services stems from its ability to significantly streamline the configuration process, especially when dealing with complex third-party services like Postgres and MinIO.
|
||||
|
||||
Should you be interested in exploring alternative deployment methods for hosting MinIO and Postgres without utilizing Docker and Docker Compose, comprehensive information is available through their respective official channels and documentation:
|
||||
|
||||
- MinIO GitHub: [Visit MinIO GitHub](https://github.com/minio/minio)
|
||||
- Postgres Github: [Visit Postgres GitHub](https://github.com/postgres/postgres)
|
||||
- MinIO documentation: [View MinIO docs](https://min.io/docs/minio/linux/index.html)
|
||||
- Postgres documentation: [View Postgres docs](https://www.postgresql.org/docs/)
|
||||
|
||||
With these foundational concepts established, we can now proceed with our detailed, step-by-step installation guide.
|
||||
|
||||
---
|
||||
|
||||
## ✅ Prerequisites
|
||||
|
||||
Before proceeding with the installation, it's essential to ensure that your development environment is properly configured with all the necessary tools and dependencies. Please verify that you have the following software components installed and properly configured on your system:
|
||||
|
||||
- <span style={{ color: "#16a34a" }}>Docker</span> *(Required only if you plan to use Docker + Docker Compose)*
|
||||
- <span style={{ color: "#16a34a" }}>Docker Compose</span> *(Required only if you plan to use Docker + Docker Compose)*
|
||||
- <span style={{ color: "#16a34a" }}>Node.js</span> *(Essential for running JavaScript/TypeScript applications)*
|
||||
- <span style={{ color: "#16a34a" }}>pnpm</span> *(Our preferred package manager)*
|
||||
- <span style={{ color: "#16a34a" }}>Git</span> *(For version control and repository management)*
|
||||
|
||||
⚠️ <strong>A critical note regarding package management:</strong> This repository has been specifically developed and thoroughly tested using the pnpm package manager. While technically possible to use alternative package managers such as `npm`, `yarn`, or `bun`, we strongly advise against this approach.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Running the Application
|
||||
|
||||
### 📥 Clone the Repository
|
||||
|
||||
To begin the installation process, you'll need to obtain a local copy of the codebase. Start by cloning the official repository using the following Git command:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/kyantech/Palmr.git
|
||||
```
|
||||
|
||||
Upon successful cloning, you'll find yourself with a new directory containing the project structure. Within this directory, there's a crucial folder named 'apps' that houses three essential components: docs, server, and web. For the purposes of this installation guide, we'll focus primarily on the server and web directories, which contain our robust backend infrastructure (built with Fastify) and our responsive frontend application (developed using React + Vite), respectively.
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Set Up Backend Services
|
||||
|
||||
The next phase involves setting up our backend services. First, navigate to the backend directory where you'll find the Docker Compose configuration file for our essential services - MinIO and Postgres:
|
||||
|
||||
```bash
|
||||
cd ./apps/server
|
||||
```
|
||||
|
||||
Once you're in the correct directory, initiate the services by executing the following command:
|
||||
|
||||
```bash
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
This command initializes both Postgres and MinIO services in detached mode, allowing them to run seamlessly in the background. While the configuration file at `apps/server/docker-compose.yaml` can be customized to suit specific needs, we strongly recommend maintaining the default configuration for your initial setup. This approach ensures a smooth installation process, and you can always refine the settings once you have a working implementation.
|
||||
|
||||
Now that our essential services are operational through Docker Compose, we can proceed with the core backend setup. During this phase, we'll be preparing the application for production deployment rather than development mode. This process requires careful attention to both the backend and frontend components.
|
||||
|
||||
Since our current working directory is already set to the server folder, let's begin with the backend configuration.
|
||||
|
||||
#### 🔑 Set Up Environment Variables
|
||||
|
||||
A crucial preliminary step is configuring the environment variables that Palmr requires for proper operation. We've provided a template file named `.env.example` in the repository to streamline this process.
|
||||
|
||||
Execute this straightforward command to create your environment configuration:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
This operation creates a new `.env` file in the root directory, populated with all the necessary environmental configurations.
|
||||
|
||||
#### 📦 Install Dependencies
|
||||
|
||||
The next crucial step involves initializing our database connection through Prisma, our chosen Object-Relational Mapping (ORM) tool. However, before we can utilize Prisma effectively, we need to ensure all backend dependencies are properly installed. With your Node.js environment and pnpm package manager ready, execute:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### ⚡ Generate Prisma Client
|
||||
|
||||
After successfully installing all dependencies, proceed with generating the Prisma client by running:
|
||||
|
||||
```bash
|
||||
pnpm dlx prisma generate
|
||||
```
|
||||
|
||||
This essential command generates the Prisma client specifically tailored for our project, establishing the necessary interface for seamless database interactions and operations.
|
||||
|
||||
#### 🔄 Deploy Prisma Migrations
|
||||
|
||||
With the client generation complete, deploy the database schema using:
|
||||
|
||||
```bash
|
||||
pnpm dlx prisma migrate deploy
|
||||
```
|
||||
|
||||
This command ensures all your database migrations are properly implemented, establishing the required database structure.
|
||||
|
||||
#### 🌱 Seed the Database
|
||||
|
||||
Following the successful migration deployment, we'll populate the database with initial data using our seeding script. Execute:
|
||||
|
||||
```bash
|
||||
pnpm db:seed
|
||||
```
|
||||
|
||||
This process will populate your database with the necessary initial data, preparing it for application use.
|
||||
|
||||
#### 🏗️ Build and Run the Backend
|
||||
|
||||
With all preparatory steps completed, we can now build the backend application:
|
||||
|
||||
```bash
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
Once the build process successfully concludes, start the backend service:
|
||||
|
||||
```bash
|
||||
pnpm start
|
||||
```
|
||||
|
||||
To verify that your backend is functioning correctly, you can access the comprehensive API documentation at:
|
||||
|
||||
```bash
|
||||
http://localhost:3333/docs
|
||||
```
|
||||
|
||||
This documentation interface provides detailed information about all available API endpoints and their usage.
|
||||
|
||||
---
|
||||
|
||||
### 🎨 Set Up Frontend
|
||||
|
||||
The frontend configuration process follows a similar pattern to the backend setup, though it's somewhat simplified as it doesn't require Docker container management - we'll only need to configure and run the service itself.
|
||||
|
||||
#### 📂 Navigate to the Frontend Directory
|
||||
|
||||
If your current location is the server directory, use:
|
||||
|
||||
```bash
|
||||
cd ../web
|
||||
```
|
||||
|
||||
Alternatively, if you're starting from the repository root, navigate with:
|
||||
|
||||
```bash
|
||||
cd apps/web
|
||||
```
|
||||
|
||||
#### ⚙️ Set Up Environment Variables
|
||||
|
||||
After reaching the web directory, begin by creating your frontend environment configuration:
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
This step mirrors our backend environment setup, ensuring all necessary variables are properly configured.
|
||||
|
||||
#### 📦 Install Dependencies
|
||||
|
||||
Proceed with installing all required frontend dependencies:
|
||||
|
||||
```bash
|
||||
pnpm install
|
||||
```
|
||||
|
||||
#### 💻 Build and Run the Frontend
|
||||
|
||||
The final stage of our frontend setup is straightforward. First, create a production build:
|
||||
|
||||
```bash
|
||||
pnpm run build
|
||||
```
|
||||
|
||||
After the build completes successfully, launch the frontend service:
|
||||
|
||||
```bash
|
||||
pnpm serve
|
||||
```
|
||||
|
||||
Once the service initialization is complete, you can access the full application through your web browser at:
|
||||
|
||||
```bash
|
||||
http://localhost:3000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎉 Conclusion
|
||||
|
||||
Congratulations! You've successfully completed the comprehensive setup process for deploying a production-ready instance of Palmr. This detailed guide has walked you through each crucial step, from initial repository cloning to final application deployment.
|
||||
|
||||
## 🔗 Useful Links
|
||||
|
||||
- [Docker Documentation](https://docs.docker.com/)
|
||||
- [Node.js Documentation](https://nodejs.org/en/docs/)
|
||||
- [pnpm Documentation](https://pnpm.io/)
|
||||
- [Prisma Documentation](https://www.prisma.io/docs/)
|
28
apps/docs/content/docs/2.0.0-beta/meta.json
Normal file
@@ -0,0 +1,28 @@
|
||||
{
|
||||
"title": "v2.0.0-beta",
|
||||
"description": "v2.0.0-beta Documentation",
|
||||
"root": true,
|
||||
"icon": "Building2",
|
||||
"pages": [
|
||||
"---Introduction---",
|
||||
"index",
|
||||
"architecture",
|
||||
"github-architecture",
|
||||
"installation",
|
||||
"manual-installation",
|
||||
"api",
|
||||
"---How to use Palmr.---",
|
||||
"manage-users",
|
||||
"uploading-files",
|
||||
"generate-share",
|
||||
"configuring-smtp",
|
||||
"available-languages",
|
||||
"---Developers---",
|
||||
"contribute",
|
||||
"open-an-issue",
|
||||
"---Sponsor this project---",
|
||||
"gh-star",
|
||||
"gh-sponsor",
|
||||
"..."
|
||||
]
|
||||
}
|
137
apps/docs/content/docs/2.0.0-beta/open-an-issue.mdx
Normal file
@@ -0,0 +1,137 @@
|
||||
---
|
||||
title: 🎫 How to open an issue
|
||||
---
|
||||
|
||||
## 👋 Introduction
|
||||
|
||||
Opening an issue on GitHub is a great way to report bugs, request features, or ask questions about a project. This tutorial will guide you through the process of opening an issue for the **Palmr.** project on GitHub.
|
||||
|
||||
Issues are an essential communication tool in open source development that help track bugs, feature requests, and general questions. They create a transparent record of project discussions and improvements. Whether you've found a bug that needs fixing, have an idea for a new feature, or just need clarification about how something works, creating an issue is the first step to getting your voice heard.
|
||||
|
||||
---
|
||||
|
||||
### 🔑 GitHub Login
|
||||
|
||||
Before you can open an issue, you need to be logged into your GitHub account. If you don't have an account yet, you can sign up for free at [GitHub](https://github.com/). Having a GitHub account allows you to:
|
||||
|
||||
- Create and manage issues
|
||||
- Comment on existing issues
|
||||
- Receive notifications about updates
|
||||
- Collaborate with other developers
|
||||
|
||||
Once you have an account, make sure you're logged in before proceeding to the next steps.
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Access the Repository
|
||||
|
||||
There are several ways to access the Palmr repository:
|
||||
|
||||
1. **Direct Link**:
|
||||
Go to the Palmr repository by clicking this link: [https://github.com/kyantech/Palmr](https://github.com/kyantech/Palmr)
|
||||
|
||||
2. **GitHub Search**:
|
||||
- Click the search bar at the top of GitHub
|
||||
- Type "Palmr" or "kyantech/Palmr"
|
||||
- Look for the repository owned by **Kyantech**
|
||||
- Click on the repository name to access it
|
||||
|
||||
3. **Through Organization**:
|
||||
- Visit [Kyantech's GitHub profile](https://github.com/kyantech)
|
||||
- Navigate to the "Repositories" tab
|
||||
- Find and click on "Palmr" in the repository list
|
||||
|
||||
---
|
||||
|
||||
### 📋 Open the Issues Tab
|
||||
|
||||
To access the issues section:
|
||||
|
||||
1. Look at the navigation bar near the top of the repository page
|
||||
2. Find the **Issues** tab - it's usually between "Code" and "Pull requests"
|
||||
3. Click on the **Issues** tab to open the issues section
|
||||
4. You'll see a list of all existing issues, both open and closed
|
||||
|
||||
The issues tab shows important information like:
|
||||
- Number of open issues
|
||||
- Issue labels and categories
|
||||
- Issue status (open/closed)
|
||||
- Recent activity
|
||||
- Assigned contributors
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### ➕ Create New Issue
|
||||
|
||||
To start creating a new issue:
|
||||
|
||||
1. Look for the green **New Issue** button on the right side of the issues page
|
||||
2. Click the button to open the issue creation form
|
||||
3. If there are multiple issue templates available, choose the most appropriate one for your needs
|
||||
4. Take time to read through the template requirements carefully
|
||||
5. Make sure you have all necessary information ready before starting
|
||||
|
||||
Pro Tips:
|
||||
- Before creating a new issue, search existing issues to avoid duplicates
|
||||
- Review any contribution guidelines or issue templates
|
||||
- Consider adding relevant labels when creating your issue
|
||||
- Include system information if reporting a bug
|
||||
- Reference related issues or pull requests if applicable
|
||||
- Use markdown formatting to make your issue more readable
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### 📝 Fill Out the Form
|
||||
|
||||
You’ll now see a form where you can provide details about your issue. Here’s how to fill it out:
|
||||
|
||||
1. **Title**: Write a clear and concise title that summarizes the issue.
|
||||
2. **Description**: Provide a detailed description of the issue. Include steps to reproduce the problem (if it’s a bug), expected behavior, and actual behavior. If you’re requesting a feature, explain why it would be useful.
|
||||
3. **Labels (Optional)**: Add labels to categorize your issue (e.g., `bug`, `enhancement`, `question`). This helps the maintainers organize and prioritize issues.
|
||||
4. **Attachments (Optional)**: You can attach screenshots, logs, or other files to help explain the issue.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
### ✅ Submit the Issue
|
||||
|
||||
Once you've filled out the form, click the **Create** button at the bottom of the page. Your issue will now be visible to the project maintainers and other contributors. You can track the status of your issue and receive notifications when there are updates or responses. Feel free to participate in any follow-up discussions in the comments section of your issue.
|
||||
|
||||
---
|
||||
|
||||
### 💡 Tips for Issues
|
||||
|
||||
To ensure your issue is addressed quickly and effectively, follow these tips:
|
||||
- **Be Clear and Specific**: Provide as much detail as possible.
|
||||
- **Use a Descriptive Title**: A good title helps maintainers understand the issue at a glance.
|
||||
- **Include Steps to Reproduce**: If it’s a bug, explain how to reproduce it.
|
||||
- **Be Polite and Respectful**: Remember that maintainers and contributors are volunteering their time.
|
||||
|
||||
---
|
||||
|
||||
### ⭐ Why Issues Matter
|
||||
|
||||
Opening issues is a key part of contributing to open-source projects. Here’s why it matters:
|
||||
1. **Improves the Project**: Your feedback helps identify bugs and suggest new features.
|
||||
2. **Helps Maintainers**: Clear and detailed issues make it easier for maintainers to address problems.
|
||||
3. **Encourages Collaboration**: Issues can spark discussions and attract contributors to help solve problems.
|
||||
|
||||
---
|
||||
|
||||
### 🎉 Final Words
|
||||
|
||||
Congratulations on creating your first issue for the **Palmr** project! Your contribution is valuable and helps make the project better for everyone. Remember:
|
||||
|
||||
- Stay engaged with your issue's progress
|
||||
- Help others when you can
|
||||
- Share your knowledge and experiences
|
||||
- Consider contributing code if possible
|
||||
- Star the repository to show support
|
||||
- Spread the word about Palmr
|
||||
|
||||
Thank you for being part of our open-source community. Your participation helps make Palmr better for everyone!
|
91
apps/docs/content/docs/2.0.0-beta/uploading-files.mdx
Normal file
@@ -0,0 +1,91 @@
|
||||
---
|
||||
title: 📤 Uploading Files
|
||||
---
|
||||
|
||||
To upload a file in Palmr, the process has been designed to be straightforward and user-friendly. The platform offers two convenient locations where users can upload their files, ensuring flexibility and ease of access. Each location has been optimized to provide a seamless upload experience.
|
||||
|
||||
Before we delve into the specifics of file uploading, it's essential to understand that file sharing stands at the heart of Palmr's functionality. This core feature enables users to collaborate and distribute content efficiently. To initiate this collaborative process, you'll need to first upload one or more files to your account. Once your files are uploaded, you can proceed to create a sharing session, which serves as a container that can encompass either a single file or multiple files, depending on your specific needs.
|
||||
|
||||
Now let's explore the file upload process in detail. As previously mentioned, the procedure has been streamlined for maximum efficiency, and you can initiate file uploads from two distinct locations: **the Home Page** or **the My Files Page**. We will thoroughly examine both options in the following sections, though it's worth noting that the underlying upload mechanism remains consistent regardless of which location you choose.
|
||||
|
||||
---
|
||||
|
||||
## 🏠 Home Page
|
||||
|
||||
On the home page, you'll find a dedicated "Recent Uploads" section. When you're using Palmr for the first time and haven't uploaded any files yet, this section will appear in its initial state:
|
||||
|
||||

|
||||
|
||||
To begin the upload process, locate and click the "Upload File" button. This action will trigger a modal window where you can browse and select the desired file from your device. For enhanced user experience, certain file formats including images, audio files, and video content will automatically generate a preview within the modal.
|
||||
|
||||

|
||||
|
||||
|
||||
**Example with an image:**
|
||||
|
||||

|
||||
|
||||
Upon selecting your file, you'll be presented with two options: confirm the upload by clicking the "Upload" button, or if you need to make changes, you can abort the process by selecting the "Cancel" button.
|
||||
|
||||

|
||||
|
||||
After successfully uploading one or more files, the "Recent Uploads" section will automatically refresh to display your newly added content:
|
||||
|
||||

|
||||
|
||||
Should you wish to upload additional files from this view, simply click the "Upload File" button positioned in the upper right corner of the section, then follow the same straightforward procedure outlined above.
|
||||
|
||||

|
||||
|
||||
It's important to note that the home page list displays only your last 5 uploads for quick access. For a comprehensive view of your uploaded files or to upload additional content, you'll need to navigate to the "My Files" page. This can be accomplished in two ways: either click the "View All" button located in the upper right corner of the section, or select the "My Files" card directly from the home page.
|
||||
|
||||

|
||||
|
||||
Or:
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 📂 My Files Page
|
||||
|
||||
Upon accessing the **"My Files"** page, you'll be presented with this comprehensive layout:
|
||||
|
||||
This interface provides enhanced functionality, allowing you to **filter** through your uploaded files for better organization. You can also continue uploading new files by clicking the **"Upload File"** button and following the previously described upload procedure.
|
||||
|
||||
For clarity, it's worth mentioning that the tables found in both the **"Recent Files"** section and the **"My Files"** page share the same structure and organization — the primary distinction lies in the quantity of files displayed. While the **"Recent Files"** section provides quick access to your five most recent uploads, the **"My Files"** table presents a comprehensive view of your entire upload history.
|
||||
|
||||
The table provides detailed information through the following fields:
|
||||
|
||||
- **Name**
|
||||
- **Description**
|
||||
- **Size**
|
||||
- **Created At**
|
||||
- **Updated At**
|
||||
- **Actions**
|
||||
|
||||
---
|
||||
|
||||
### ⚙️ Actions Column
|
||||
|
||||
Within the **"Actions"** column, you'll discover an interactive icon that reveals the following dropdown menu:
|
||||
|
||||

|
||||
|
||||
While most options are self-explanatory, let's examine the Edit functionality in detail:
|
||||
|
||||
- Edit – Opens a modal where you can modify various file attributes including the file name, description, and other relevant details.
|
||||
|
||||

|
||||
|
||||
- The platform also provides the ability to **delete** files directly through the dropdown menu by selecting the **Delete** option.
|
||||
|
||||
For enhanced user experience, the preview functionality is available for common media formats including images, audio files, PDFs, and videos. For all other file types, you can easily access the content through the **Download** option in the dropdown menu.
|
||||
|
||||
---
|
||||
|
||||
## 📝 Notes and Recommendations
|
||||
|
||||
- To ensure optimal performance and user experience, we strongly recommend uploading files that have been properly optimized.
|
||||
- For troubleshooting purposes, all upload errors and related issues are systematically logged and can be accessed through the administrative panel.
|
||||
- System administrators have full control over file access permissions and can manage them as needed.
|
3
apps/docs/content/docs/meta.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"pages": ["2.0.0-beta", "1.1.7-beta"]
|
||||
}
|
29
apps/docs/next.config.mjs
Normal file
@@ -0,0 +1,29 @@
|
||||
import { createMDX } from 'fumadocs-mdx/next';
|
||||
|
||||
const withMDX = createMDX();
|
||||
|
||||
/** @type {import('next').NextConfig} */
|
||||
const config = {
|
||||
reactStrictMode: true,
|
||||
eslint: {
|
||||
ignoreDuringBuilds: true,
|
||||
},
|
||||
typescript: {
|
||||
ignoreBuildErrors: true,
|
||||
},
|
||||
images: {
|
||||
qualities: [100],
|
||||
remotePatterns: [
|
||||
{
|
||||
protocol: 'https',
|
||||
hostname: '**'
|
||||
},
|
||||
{
|
||||
protocol: 'http',
|
||||
hostname: '**'
|
||||
}
|
||||
]
|
||||
}
|
||||
};
|
||||
|
||||
export default withMDX(config);
|
@@ -1,17 +1,37 @@
|
||||
{
|
||||
"name": "palmr-docs",
|
||||
"type": "module",
|
||||
"version": "1.1.6",
|
||||
"name": "docs-v2",
|
||||
"version": "0.0.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"dev": "astro dev",
|
||||
"start": "astro preview",
|
||||
"build": "astro build && cp -r public dist/",
|
||||
"preview": "astro preview",
|
||||
"astro": "astro"
|
||||
"build": "next build",
|
||||
"dev": "next dev --turbo",
|
||||
"start": "next start",
|
||||
"postinstall": "fumadocs-mdx"
|
||||
},
|
||||
"dependencies": {
|
||||
"@astrojs/starlight": "^0.32.2",
|
||||
"astro": "^5.1.5",
|
||||
"sharp": "^0.32.5"
|
||||
"class-variance-authority": "^0.7.1",
|
||||
"clsx": "^2.1.1",
|
||||
"fumadocs-core": "15.2.7",
|
||||
"fumadocs-mdx": "11.6.0",
|
||||
"fumadocs-ui": "15.2.7",
|
||||
"lucide-react": "^0.488.0",
|
||||
"motion": "^12.9.1",
|
||||
"next": "15.3.0",
|
||||
"react": "^19.1.0",
|
||||
"react-dom": "^19.1.0",
|
||||
"tailwind-merge": "^3.2.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@tailwindcss/postcss": "^4.1.3",
|
||||
"@types/mdx": "^2.0.13",
|
||||
"@types/node": "22.14.0",
|
||||
"@types/react": "^19.1.0",
|
||||
"@types/react-dom": "^19.1.2",
|
||||
"eslint": "^8",
|
||||
"eslint-config-next": "15.3.0",
|
||||
"postcss": "^8.5.3",
|
||||
"tailwindcss": "^4.1.3",
|
||||
"tw-animate-css": "^1.2.8",
|
||||
"typescript": "^5.8.3"
|
||||
}
|
||||
}
|
6543
apps/docs/pnpm-lock.yaml
generated
5
apps/docs/postcss.config.mjs
Normal file
@@ -0,0 +1,5 @@
|
||||
export default {
|
||||
plugins: {
|
||||
'@tailwindcss/postcss': {},
|
||||
},
|
||||
};
|
Before Width: | Height: | Size: 222 KiB After Width: | Height: | Size: 222 KiB |
Before Width: | Height: | Size: 182 KiB After Width: | Height: | Size: 182 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
Before Width: | Height: | Size: 120 KiB After Width: | Height: | Size: 120 KiB |
Before Width: | Height: | Size: 134 KiB After Width: | Height: | Size: 134 KiB |
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 526 KiB After Width: | Height: | Size: 526 KiB |
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 94 KiB After Width: | Height: | Size: 94 KiB |
Before Width: | Height: | Size: 36 KiB After Width: | Height: | Size: 36 KiB |
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 7.5 KiB After Width: | Height: | Size: 7.5 KiB |
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 23 KiB After Width: | Height: | Size: 23 KiB |
Before Width: | Height: | Size: 48 KiB After Width: | Height: | Size: 48 KiB |
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
Before Width: | Height: | Size: 68 KiB After Width: | Height: | Size: 68 KiB |
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
Before Width: | Height: | Size: 17 KiB After Width: | Height: | Size: 17 KiB |
Before Width: | Height: | Size: 156 KiB After Width: | Height: | Size: 156 KiB |
Before Width: | Height: | Size: 6.1 KiB After Width: | Height: | Size: 6.1 KiB |
Before Width: | Height: | Size: 108 KiB After Width: | Height: | Size: 108 KiB |
Before Width: | Height: | Size: 85 KiB After Width: | Height: | Size: 85 KiB |
Before Width: | Height: | Size: 55 KiB After Width: | Height: | Size: 55 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 46 KiB |
Before Width: | Height: | Size: 5.5 KiB After Width: | Height: | Size: 5.5 KiB |
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 19 KiB |
Before Width: | Height: | Size: 5.1 KiB After Width: | Height: | Size: 5.1 KiB |
Before Width: | Height: | Size: 102 KiB After Width: | Height: | Size: 102 KiB |
Before Width: | Height: | Size: 30 KiB After Width: | Height: | Size: 30 KiB |
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
Before Width: | Height: | Size: 5.8 KiB After Width: | Height: | Size: 5.8 KiB |
Before Width: | Height: | Size: 8.7 KiB After Width: | Height: | Size: 8.7 KiB |
Before Width: | Height: | Size: 4.8 KiB After Width: | Height: | Size: 4.8 KiB |
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 18 KiB |
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
Before Width: | Height: | Size: 9.4 KiB After Width: | Height: | Size: 9.4 KiB |
Before Width: | Height: | Size: 38 KiB After Width: | Height: | Size: 38 KiB |
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
Before Width: | Height: | Size: 78 KiB After Width: | Height: | Size: 78 KiB |
Before Width: | Height: | Size: 8.7 KiB After Width: | Height: | Size: 8.7 KiB |
Before Width: | Height: | Size: 174 KiB After Width: | Height: | Size: 174 KiB |