Skip to content

Commit 8341bf4

Browse files
rahim-jrrahim-jr
committed
docs: organize and restructure project documentation
- Add comprehensive FEATURES.md with detailed feature specifications - Update ROADMAP.md with MoSCoW prioritization and clear phases - Remove temporary template files and organize docs folder - Resolve merge conflicts from upstream changes - Add GitHub templates and workflows for better project management Features documented include: - One-click room creation - WebRTC P2P audio streaming - Browser-native audio processing - Room persistence and moderation tools - Client-side recording capabilities Roadmap includes clear phases: - v0.1.0: MVP (completed) - v0.1.1: Stability & Performance (in progress) - v0.2.0: Moderation & Recording (planned) - v0.3.0: Scalability (future)
1 parent 2a03473 commit 8341bf4

File tree

15 files changed

+1098
-64
lines changed

15 files changed

+1098
-64
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: ['bug']
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+
**Environment (please complete the following information):**
27+
- OS: [e.g. Windows 10, macOS 12.0, Ubuntu 20.04]
28+
- Browser: [e.g. Chrome 91, Firefox 89, Safari 14]
29+
- Browser Version: [e.g. 91.0.4472.124]
30+
- Go Version: [e.g. 1.19.0] (for backend issues)
31+
32+
**Additional context**
33+
Add any other context about the problem here.
34+
35+
**Logs**
36+
If applicable, add relevant log output or error messages.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: ['enhancement']
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+
**Use case**
20+
Describe the specific use case or scenario where this feature would be helpful.
21+
22+
**Additional context**
23+
Add any other context or screenshots about the feature request here.
24+
25+
**Implementation ideas**
26+
If you have ideas about how this could be implemented, please share them here.
27+
28+
**Priority**
29+
- [ ] Low - Nice to have
30+
- [ ] Medium - Would be helpful
31+
- [ ] High - Important for my use case
32+
- [ ] Critical - Blocking my usage

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
## Description
2+
Brief description of what this PR does.
3+
4+
## Related Issue
5+
Closes #(issue number)
6+
7+
## Type of Change
8+
- [ ] Bug fix (non-breaking change which fixes an issue)
9+
- [ ] New feature (non-breaking change which adds functionality)
10+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
11+
- [ ] Documentation update
12+
- [ ] Code refactoring
13+
- [ ] Performance improvement
14+
- [ ] Test addition/update
15+
16+
## Testing
17+
- [ ] I have tested this change locally
18+
- [ ] I have added tests that prove my fix is effective or that my feature works
19+
- [ ] New and existing unit tests pass locally with my changes
20+
- [ ] I have tested this change in multiple browsers (if applicable)
21+
22+
## Screenshots (if applicable)
23+
Add screenshots to help explain your changes.
24+
25+
## Checklist
26+
- [ ] My code follows the project's coding guidelines
27+
- [ ] I have performed a self-review of my own code
28+
- [ ] I have commented my code, particularly in hard-to-understand areas
29+
- [ ] I have made corresponding changes to the documentation
30+
- [ ] My changes generate no new warnings
31+
- [ ] I have added tests that prove my fix is effective or that my feature works
32+
- [ ] New and existing unit tests pass locally with my changes
33+
- [ ] Any dependent changes have been merged and published
34+
35+
## Additional Notes
36+
Any additional information that reviewers should know.

‎.github/workflows/ci.yml‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Set up Go
17+
uses: actions/setup-go@v4
18+
with:
19+
go-version: '1.19'
20+
21+
- name: Cache Go modules
22+
uses: actions/cache@v3
23+
with:
24+
path: ~/go/pkg/mod
25+
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
26+
restore-keys: |
27+
${{ runner.os }}-go-
28+
29+
- name: Install dependencies
30+
run: |
31+
cd backend
32+
go mod download
33+
go mod verify
34+
35+
- name: Run tests
36+
run: |
37+
cd backend
38+
go test -v ./...
39+
40+
- name: Run linting
41+
run: |
42+
cd backend
43+
go vet ./...
44+
go fmt ./...
45+
46+
- name: Build
47+
run: |
48+
cd backend
49+
go build -v ./cmd/server

‎.gitignore‎

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# Binaries for programs and plugins
2+
*.exe
3+
*.exe~
4+
*.dll
5+
*.so
6+
*.dylib
7+
8+
# Test binary, built with `go test -c`
9+
*.test
10+
11+
# Output of the go coverage tool, specifically when used with LiteIDE
12+
*.out
13+
14+
# Dependency directories (remove the comment below to include it)
15+
# vendor/
16+
17+
# Go workspace file
18+
go.work
19+
20+
# IDE files
21+
.vscode/
22+
.idea/
23+
*.swp
24+
*.swo
25+
*~
26+
27+
# OS generated files
28+
.DS_Store
29+
.DS_Store?
30+
._*
31+
.Spotlight-V100
32+
.Trashes
33+
ehthumbs.db
34+
Thumbs.db
35+
36+
# Environment variables
37+
.env
38+
.env.local
39+
.env.development.local
40+
.env.test.local
41+
.env.production.local
42+
43+
# Logs
44+
logs
45+
*.log
46+
npm-debug.log*
47+
yarn-debug.log*
48+
yarn-error.log*
49+
50+
# Runtime data
51+
pids
52+
*.pid
53+
*.seed
54+
*.pid.lock
55+
56+
# Coverage directory used by tools like istanbul
57+
coverage/
58+
*.lcov
59+
60+
# nyc test coverage
61+
.nyc_output
62+
63+
# Dependency directories
64+
node_modules/
65+
66+
# Optional npm cache directory
67+
.npm
68+
69+
# Optional REPL history
70+
.node_repl_history
71+
72+
# Output of 'npm pack'
73+
*.tgz
74+
75+
# Yarn Integrity file
76+
.yarn-integrity
77+
78+
# parcel-bundler cache (https://parceljs.org/)
79+
.cache
80+
.parcel-cache
81+
82+
# next.js build output
83+
.next
84+
85+
# nuxt.js build output
86+
.nuxt
87+
88+
# vuepress build output
89+
.vuepress/dist
90+
91+
# Serverless directories
92+
.serverless
93+
94+
# FuseBox cache
95+
.fusebox/
96+
97+
# DynamoDB Local files
98+
.dynamodb/
99+
100+
# TernJS port file
101+
.tern-port
102+
103+
# Stores VSCode versions used for testing VSCode extensions
104+
.vscode-test
105+
106+
# Temporary folders
107+
tmp/
108+
temp/
109+
110+
# Build outputs
111+
dist/
112+
build/

‎FEATURES_TEMP.md‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 BGCE Stream Contributors
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 all
13+
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 THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)