Skip to content
This repository was archived by the owner on Jan 11, 2026. It is now read-only.

Commit 62a83ca

Browse files
committed
DNP
0 parents  commit 62a83ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+5408
-0
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
docker-compose.yml
2+
.DS_Store
3+
.vscode/
4+
.env

.hintrc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"extends": [
3+
"development"
4+
],
5+
"hints": {
6+
"no-inline-styles": "off"
7+
}
8+
}

ACKNOWLEDGMENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Acknowledgments
2+
3+
This project incorporates several open-source libraries and tools. We would like to acknowledge and thank the contributors of these projects.
4+
5+
## Frontend Dependencies
6+
7+
- **Next.js** - MIT License
8+
- **React** - MIT License
9+
- **ts-chacha20** - MIT License
10+
- **zod** - MIT License
11+
- **Tailwind CSS** - MIT License
12+
- **Framer Motion** - MIT License
13+
14+
## Backend Dependencies
15+
16+
- **FastAPI** - MIT License
17+
- **Uvicorn** - BSD 3-Clause License
18+
- **SQLAlchemy** - MIT License
19+
- **python-ulid** - MIT License
20+
- **bcrypt** - Apache License 2.0

AUTHORS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Authors
2+
3+
- **Daniil Gazizullin**
4+
Project maintainer and core contributor.

CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [v0.1.0] - 2025-30-04
6+
7+
### Added
8+
- Initial release with all features

CODE_OF_CONDUCT.md

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
2+
# Contributor Covenant Code of Conduct
3+
4+
## Our Pledge
5+
6+
We as members, contributors, and leaders pledge to make participation in our
7+
community a harassment-free experience for everyone, regardless of age, body
8+
size, visible or invisible disability, ethnicity, sex characteristics, gender
9+
identity and expression, level of experience, education, socio-economic status,
10+
nationality, personal appearance, race, caste, color, religion, or sexual
11+
identity and orientation.
12+
13+
We pledge to act and interact in ways that contribute to an open, welcoming,
14+
diverse, inclusive, and healthy community.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to a positive environment for our
19+
community include:
20+
21+
* Demonstrating empathy and kindness toward other people
22+
* Being respectful of differing opinions, viewpoints, and experiences
23+
* Giving and gracefully accepting constructive feedback
24+
* Accepting responsibility and apologizing to those affected by our mistakes,
25+
and learning from the experience
26+
* Focusing on what is best not just for us as individuals, but for the overall
27+
community
28+
29+
Examples of unacceptable behavior include:
30+
31+
* The use of sexualized language or imagery, and sexual attention or advances of
32+
any kind
33+
* Trolling, insulting or derogatory comments, and personal or political attacks
34+
* Public or private harassment
35+
* Publishing others' private information, such as a physical or email address,
36+
without their explicit permission
37+
* Other conduct which could reasonably be considered inappropriate in a
38+
professional setting
39+
40+
## Enforcement Responsibilities
41+
42+
Community leaders are responsible for clarifying and enforcing our standards of
43+
acceptable behavior and will take appropriate and fair corrective action in
44+
response to any behavior that they deem inappropriate, threatening, offensive,
45+
or harmful.
46+
47+
Community leaders have the right and responsibility to remove, edit, or reject
48+
comments, commits, code, wiki edits, issues, and other contributions that are
49+
not aligned to this Code of Conduct, and will communicate reasons for moderation
50+
decisions when appropriate.
51+
52+
## Scope
53+
54+
This Code of Conduct applies within all community spaces, and also applies when
55+
an individual is officially representing the community in public spaces.
56+
Examples of representing our community include using an official email address,
57+
posting via an official social media account, or acting as an appointed
58+
representative at an online or offline event.
59+
60+
## Enforcement
61+
62+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
63+
reported to the community leaders responsible for enforcement at
64+
[INSERT CONTACT METHOD].
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series of
87+
actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or permanent
94+
ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within the
114+
community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.1, available at
120+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
121+
122+
Community Impact Guidelines were inspired by
123+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
124+
125+
For answers to common questions about this code of conduct, see the FAQ at
126+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
127+
[https://www.contributor-covenant.org/translations][translations].
128+
129+
[homepage]: https://www.contributor-covenant.org
130+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
131+
[Mozilla CoC]: https://github.com/mozilla/diversity
132+
[FAQ]: https://www.contributor-covenant.org/faq
133+
[translations]: https://www.contributor-covenant.org/translations
134+

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contributing
2+
3+
Thank you for your interest in this project. At this time, we are not accepting contributions.
4+
5+
If you have questions or issues, please refer to the documentation or open an issue if necessary.

CONTRIBUTORS.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contributors
2+
3+
- **ChatGPT**, **Anthropic Claude**, **GitHub Copilot**, **Google Gemini**
4+
Assisted with documentation and code suggestions.

INSTALL.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# INSTALL.md
2+
3+
## 📦 Sharder Installation Guide
4+
5+
This guide explains how to install and run the **Sharder** distributed storage platform, either via Docker (recommended) or manually. It also includes instructions for deploying individual shards.
6+
7+
---
8+
9+
## 🚀 Quick Start (Docker-Based Deployment)
10+
11+
### 1. Clone the Repository
12+
13+
```bash
14+
git clone https://github.com/hikariatama/sharder
15+
cd sharder
16+
```
17+
18+
### 2. Generate Docker Compose Configuration
19+
20+
```bash
21+
python3 docker-compose-generator.py \
22+
--chunks-per-file 2 \
23+
--replicas 3 \
24+
--public-port 3333 \
25+
--dev-shards 7
26+
```
27+
28+
**Available options:**
29+
30+
| Option | Description | Default |
31+
|---------------------|------------------------------------------------------|---------|
32+
| `--chunks-per-file` | Number of chunks to split each file into | `3` |
33+
| `--replicas` | Number of redundant copies per chunk | `2` |
34+
| `--public-port` | Port for the public-facing API | `80` |
35+
| `--dev-shards` | Number of local shards to run for development | `0` |
36+
37+
### 3. Launch the Stack
38+
39+
```bash
40+
sudo docker compose up -d --build
41+
```
42+
43+
---
44+
45+
## ⚙️ Manual Shard Deployment
46+
47+
To run a shard instance independently:
48+
49+
### 1. Build the Shard Binary
50+
51+
```bash
52+
mkdir /tmp/shard
53+
cd /tmp/shard
54+
wget https://sharder.dgazizullin.dev/bin/shard.tar.gz
55+
tar xvf shard.tar.gz
56+
sudo apt install build-essential libcurl4-openssl-dev
57+
make
58+
cd bin
59+
```
60+
61+
### 2. Retrieve Connection URL
62+
63+
Open the Sharder web UI, type `chimera`, and navigate to the "Management" menu to obtain your shard connection URL.
64+
65+
### 3. Launch the Shard
66+
67+
Use the command provided in the UI to start your shard. On first run, execute as `root`, or use the `--dry` flag to perform a test run.
68+
69+
> ℹ️ The shard installs itself as a `systemd` service and moves to `/opt/shard` by default.
70+
71+
---
72+
73+
For more information, visit the [project repository](https://github.com/hikariatama/sharder).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2011-2025 The Bootstrap Authors
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.

0 commit comments

Comments
 (0)