Skip to content

Commit 124997c

Browse files
westshgitwestshgit
committed
initial commit
0 parents  commit 124997c

File tree

76 files changed

+2417
-0
lines changed

Some content is hidden

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

76 files changed

+2417
-0
lines changed

‎.cargo/config.toml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/workflows/ci.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: "Codora CI"
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
jobs:
11+
docs:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v3
16+
17+
- name: Build and deploy docs
18+
run: echo "Building and deploying docs"

‎.gitignore‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# Ignore Node.js dependencies and lockfiles
2+
node_modules/
3+
package-lock.json
4+
pnpm-lock.yaml
5+
yarn.lock
6+
bun.lockb
7+
coverage
8+
bun.lock
9+
# Ignore Rust target directory (compiled binaries)
10+
target/
11+
**/target/
12+
13+
# Ignore Rust-specific files
14+
Cargo.lock
15+
*.rs.bk
16+
*.rmeta
17+
18+
# Ignore environment variables and secrets
19+
.env
20+
.env.local
21+
.env.development.local
22+
.env.test.local
23+
.env.production.local
24+
25+
# Ignore build and generated files
26+
dist/
27+
out/
28+
.build/
29+
.cache/
30+
.docusaurus/
31+
.svelte-kit/
32+
.next/
33+
.vite/
34+
wasm-pack/
35+
pkg/
36+
37+
# Ignore logs and debug files
38+
npm-debug.log*
39+
yarn-debug.log*
40+
yarn-error.log*
41+
pnpm-debug.log*
42+
cargo-debug.log*
43+
cargo-test.log*
44+
turbo-debug.log*
45+
lerna-debug.log*
46+
*.log
47+
48+
# Ignore temporary files
49+
.DS_Store
50+
Thumbs.db
51+
*.swp
52+
*.swo
53+
*.sublime-workspace
54+
55+
# Ignore IDE and editor files
56+
.idea/
57+
.vscode/
58+
*.iml
59+
*.suo
60+
*.ntvs*
61+
*.njsproj
62+
*.sln
63+
*.sw?
64+
65+
# Ignore GitHub Actions and deployment artifacts
66+
.github/workflows/node_modules/
67+
.github/workflows/dist/
68+
69+
# Ignore WebAssembly (WASM) build artifacts
70+
*.wasm
71+
*.wat
72+
*.wast
73+
74+
# docusaurus
75+
docs/.docusaurus
76+
.docusaurus
77+
**/.docusaurus
78+
79+
# templates
80+
templates/*
81+
**/templates
82+
83+
.turbo
84+
85+
dev.*rs
86+
dev/**
87+
**/dev/**

‎CONTRIBUTION.md‎

Whitespace-only changes.

‎Cargo.toml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
[workspace]
2+
members = ["crates/*"]
3+
resolver = "3"
4+
5+
[workspace.package]
6+
edition = "2024"
7+
8+
9+
[workspace.dependencies]
10+
# Internal crates
11+
codora-framework = { path = "./crates/codora-framework" }
12+
codora-framework-ws = { path = "./crates/codora-framework-ws" }
13+
codora-framework-bot = { path = "./crates/codora-framework-bot" }
14+
codora-framework-web = { path = "./crates/codora-framework-web" }
15+
codora-framework-orm = { path = "./crates/codora-framework-orm" }
16+
codora-framework-conf = { path = "./crates/codora-framework-conf" }
17+
codora-framework-axum = { path = "./crates/codora-framework-axum" }
18+
codora-framework-macro = { path = "./crates/codora-framework-macro" }
19+
codora-framework-worker = { path = "./crates/codora-framework-worker" }
20+
codora-framework-bucket = { path = "./crates/codora-framework-bucket" }
21+
codora-framework-adapter = { path = "./crates/codora-framework-adapter" }
22+
codora-framework-identity = { path = "./crates/codora-framework-identity" }
23+
codora-framework-security = { path = "./crates/codora-framework-security" }
24+
# External crates
25+
tokio = "1.47.1"
26+
tracing = "0.1.41"
27+
axum = "0.8.4"
28+
axum-core = "0.5.2"
29+
anyhow = "1.0.100"
30+
tower = "0.5.2"
31+
uuid = "1.17.0"
32+
serde = "1.0.226"
33+
serde_json = "1.0.145"
34+
thiserror = "2.0.16"
35+
derive_more = "2.0.1"
36+
derive-new = { version = "0.7.0" }
37+
tower-service = "0.3.3"
38+
tracing-subscriber = "0.3.20"
39+
40+
[workspace.lints]
41+
42+
43+
[patch.crates-io]
44+
# Add patch here

‎Makefile‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
DOCSDIR = docs
2+
3+
TEST_CRATES = jacana jacana-api jacana-bot jacana-plugin
4+
TEST_CMD = cargo test -p
5+
6+
# Generic test target: make test-<package>
7+
test-%:
8+
$(TEST_CMD) $* --lib -- --show-output
9+
10+
# Generic script command for package/jacana: make web-lint would lint the packages/jacana
11+
pkg-%:
12+
(cd $(DOCSDIR) && bun run $*)
13+
14+
pkg:
15+
(cd $(DOCSDIR) && $(CMD))

‎README.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Codora Framework
2+
3+
## Getting Started
4+
5+
codora framework designed to simplify web and any sort of development in the Rust ecosystem. To learn more about it:
6+
7+
- **Documentation:** [codora Docs](https://codetheproject.github.io/codora-framework "codora Docs")
8+
- **Repository:** [codora GitHub](https://github.com/codetheproject/codora-framework "codora Repo")
9+
10+
⚠️ **Warning:**
11+
codora framework is currently **work in progress (WIP)** — expect **frequent breaking API changes** as we continue to iterate and improve the framework. Please pin your versions carefully and stay updated with the latest changelogs.
12+
13+
## Community
14+
15+
We’re in the process of building a community. Stay tuned for an official community link — we’d love to have you join us!
16+
17+
## Contribution
18+
19+
codora framework is open to contributions, and we highly appreciate your support, whether through code, monetary contributions, or other forms of assistance. Before contributing, please read our **[Contribution Guidelines](CONTRIBUTION.md)** to understand the coding style and project structure. If you have any suggestions, feel free to contact the maintainer:
20+
21+
- **Discord:** \[WIP\]
22+
- **Email:** \[WIP\]
23+
24+
## Security
25+
26+
If you discover a security vulnerability, please report it through our official security disclosure process. Submit your security concerns via [Security](SECURITY.md).
27+
28+
---
29+
30+
Stay tuned for updates as we improve codora! 🚀

‎SECURITY.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Security Policy
2+
3+
## Security Contact
4+
5+
If you believe you've discovered a security issue in this project, please contact us:
6+
7+
- **[Email Us](mailto://[email protected], "West Sheriff email address")**
8+
9+
Please **do not report security vulnerabilities through public GitHub issues**.
10+
11+
## Reporting a Vulnerability
12+
13+
When reporting a vulnerability, include:
14+
15+
1. **Description of the issue**
16+
2. **Steps to reproduce**
17+
3. **Expected vs. actual behavior**
18+
4. **Affected versions**
19+
5. **Additional context** (if relevant)
20+
21+
Your report will be reviewed promptly. A public acknowledgment will be made once the issue is resolved.
22+
23+
## Response and Coordination
24+
25+
We will aim to respond to all security reports within **7 business days**. Once the issue is confirmed, we will:
26+
27+
1. Fix the issue promptly or release an appropriate workaround.
28+
2. Publish a security advisory through GitHub Security Advisories when necessary.

0 commit comments

Comments
 (0)