Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/.markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"config": {
"MD013": false,
"MD024": {
"siblings_only": true
}
},
"globs": [
"**/*.md",
"!**/node_modules/**",
"!**/target/**",
"!**/venv/**",
"!**/.venv/**",
"!LICENSE.md"
]
}
6 changes: 5 additions & 1 deletion .github/workflows/pr-check-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ jobs:
- name: Checkout Code
uses: actions/checkout@v3

- name: Markdown lint
uses: DavidAnson/markdownlint-cli2-action@v23
with:
config: .github/.markdownlint-cli2.jsonc

- name: Set up Node.js
uses: actions/setup-node@v3
with:
Expand Down Expand Up @@ -87,4 +92,3 @@ jobs:
run: |
cd backend
pytest

8 changes: 4 additions & 4 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
aossie.oss@gmail.com.
<aossie.oss@gmail.com>.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down Expand Up @@ -116,13 +116,13 @@ the community.

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
<https://www.contributor-covenant.org/faq>. Translations are available at
<https://www.contributor-covenant.org/translations>.
42 changes: 22 additions & 20 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Hi there! Thank you for considering contributing to **PictoPy** – we’re exci

NOTE: Please do not open a PR for the issue which is not yet reviewed and labelled by the maintainer. Wait for the maintainer to give a green light.

# Setting Up the Project
## Setting Up the Project

## Setup

Expand All @@ -20,40 +20,40 @@ To set up and run the docs website on your local machine:
1. Ensure you have **Python 3** and **pip** installed. Navigate to the `/docs` folder.
2. Create a virtual environment:

```bash
python -m venv .docs-env
```
```bash
python -m venv .docs-env
```

3. Activate the virtual environment:

```bash
# On macOS/Linux:
source .docs-env/bin/activate
# On Windows:
.docs-env\Scripts\activate
```
```bash
# On macOS/Linux:
source .docs-env/bin/activate
# On Windows:
.docs-env\Scripts\activate
```

4. Install the required Python packages:

```bash
pip install -r requirements.txt
```
```bash
pip install -r requirements.txt
```

5. Start the local MkDocs server:

```bash
mkdocs serve -f ../mkdocs.yml
```
```bash
mkdocs serve -f ../mkdocs.yml
```

6. Open your browser and navigate to: http://127.0.0.1:8000.
6. Open your browser and navigate to: <http://127.0.0.1:8000>.

7. Edit Markdown files inside the `docs/` folder. The site will automatically reload when changes are saved.

8. To build the static site for production deployment, run:

```bash
mkdocs build -f ../mkdocs.yml
```
```bash
mkdocs build -f ../mkdocs.yml
```

## Testing

Expand All @@ -67,10 +67,12 @@ npm test
### Backend

- FastAPI

```bash
cd backend
pytest
```

- Tauri

```bash
Expand Down
6 changes: 4 additions & 2 deletions COPYRIGHT.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Copyright © 2026 AOSSIE <br />
# Copyright Notice

Copyright © 2026 AOSSIE
All rights reserved.

All works in this repository may be used according to the conditions
All works in this repository may be used according to the conditions
stated in the LICENSE.md file available in this repository.

These works are WITHOUT ANY WARRANTY, without even the implied warranty of
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- markdownlint-disable MD033 MD041 -->
<!-- Don't delete it -->
<div name="readme-top"></div>

Expand Down Expand Up @@ -42,16 +43,19 @@ Find out more at [https://pictopy.aossie.org/](https://pictopy.aossie.org/).

## Features

**AI-powered**
### AI-powered

* Smart tagging based on detected faces and objects
* Advanced image analysis with object detection and facial recognition
* Smart search and retrieval

**Gallery management**
### Gallery management

* Album management with traditional gallery features
* Cross-platform compatibility

**Privacy & performance**
### Privacy & performance

* Privacy-focused design with fully offline functionality
* Efficient data handling and parallel processing

Expand Down Expand Up @@ -94,7 +98,7 @@ Find out more at [https://pictopy.aossie.org/](https://pictopy.aossie.org/).

## Want to Contribute?

<a href="https://discord.gg/hjUhu33uAn"><img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" height="30"></a>
<a href="https://discord.gg/hjUhu33uAn"><img src="https://img.shields.io/discord/1022871757289422898?style=flat&logo=discord&logoColor=white&logoSize=auto&label=Discord&labelColor=5865F2&color=57F287" alt="Discord" height="30"></a>

1. First, join the **[Discord Server](https://discord.gg/hjUhu33uAn) (Go to Projects->PictoPy)** to chat with everyone.
2. For detailed setup instructions, coding guidelines, and the contribution process, please check out our [CONTRIBUTING.md](./CONTRIBUTING.md) file.
Expand All @@ -103,7 +107,6 @@ Don't forget to star this repository if you find it useful! ⭐

Our Code of Conduct: [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)


## License

This project is licensed under the GNU General Public License v3.0.
Expand All @@ -115,4 +118,4 @@ Thanks a lot for spending your time helping TODO grow. Keep rocking 🥂

[![Contributors](https://contrib.rocks/image?repo=AOSSIE-Org/PictoPy)](https://github.com/AOSSIE-Org/PictoPy/graphs/contributors)

© 2026 AOSSIE
© 2026 AOSSIE
2 changes: 1 addition & 1 deletion backend/dist/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
## Do not delete the "dist" folder.
# Do not delete the "dist" folder

This folder is essential for the development environment to start.
Loading
Loading