Skip to content

Commit 8844932

Browse files
m-mdy-mm-mdy-m
committed
chore: initial Project
0 parents  commit 8844932

File tree

12 files changed

+1150
-0
lines changed

12 files changed

+1150
-0
lines changed

‎.env.example

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
BOT_TOKEN=<your_bot_token>
2+
WAKATIME_TOKEN=<your_api_wakatime_token>

‎.github/workflows/ci.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Run Ci For WakaTime
2+
on:
3+
push:
4+
branches:
5+
- main
6+
tags:
7+
- "v*"
8+
pull_request:
9+
branches:
10+
- main
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout code
17+
uses: actions/checkout@v3
18+
19+
- name: Run WakaTime Test
20+
run: |
21+
# Just example (not implemented test)
22+
echo "Running WakaTime CI step"

‎.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
node_modules
2+
.env
3+

‎LICNESE

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

‎README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# WakaTime Telegram Bot
2+
3+
A Telegram bot that integrates with WakaTime to track and display the top 10 coders based on their coding activity. The bot allows users to join the leaderboard by linking their WakaTime API key with their Telegram username.
4+
5+
## Installation and Setup
6+
7+
1. **Clone the Repository:**
8+
```bash
9+
git clone https://github.com/CodeModule-ir/WakaTime.git
10+
cd WakaTime
11+
```
12+
13+
## Contributing
14+
15+
We welcome contributions! Please follow the [Contribution Guidelines](docs/CONTRIBUTE.md). Ensure all commits follow the [Conventional Commit](https://www.conventionalcommits.org/) standard.
16+
17+
---
18+
19+
## License
20+
21+
This project is licensed under the MIT License. See [LICENSE](LICENSE) for details.
22+
23+
---
24+
25+
## Contact
26+
27+
For questions or support, email us at [codemoduletm@gmail.com](mailto:codemoduletm@gmail.com).
28+
Visit our GitHub: [CodeModule/WakaTime](https://github.com/CodeModule-ir/WakaTime.git)

‎docs/CODE_OF_CONDUCT.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
We aim to create a welcoming, inclusive, and respectful environment for everyone, regardless of their background, experience, or identity.
5+
6+
## Expected Behavior
7+
- Be respectful and considerate in all communications.
8+
- Provide constructive feedback.
9+
- Follow the contribution guidelines.
10+
11+
## Unacceptable Behavior
12+
- Harassment, discrimination, or hate speech.
13+
- Spamming or posting irrelevant content.
14+
- Any behavior that makes contributors feel unwelcome.
15+
16+
## Reporting Issues
17+
If you witness or experience unacceptable behavior, please report it to [codemoduletm@gmail.com](mailto:codemoduletm@gmail.com).
18+

‎docs/CONTRIBUTE.md

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
# Contribution Guidelines
2+
3+
Thank you for considering contributing to our project! Please follow these guidelines to ensure a smooth process.
4+
5+
---
6+
7+
## How to Contribute
8+
9+
1. **Fork the Repository:**
10+
Start by forking the repository at [CodeModule/WakaTime](https://github.com/CodeModule-ir/WakaTime.git).
11+
12+
2. **Clone Your Fork:**
13+
```bash
14+
git clone https://github.com/your-username/WakaTime.git
15+
cd WakaTime
16+
```
17+
18+
3. **Create a Feature Branch:**
19+
Use a descriptive branch name:
20+
```bash
21+
git checkout -b feature/add-new-command
22+
```
23+
24+
4. **Commit Changes:**
25+
Follow the [Conventional Commit](https://www.conventionalcommits.org/) standard for commit messages:
26+
- **Format:**
27+
```
28+
<type>[optional scope]: <description>
29+
30+
[optional body]
31+
32+
[optional footer(s)]
33+
```
34+
- **Examples:**
35+
- `feat(commands): add /stats command`
36+
- `fix(api): handle missing parameters error`
37+
38+
5. **Push Your Branch:**
39+
```bash
40+
git push origin feature/add-new-command
41+
```
42+
43+
6. **Submit a Pull Request (PR):**
44+
Go to your forked repository and click "New Pull Request." Provide a clear description of your changes.
45+
46+
---
47+
48+
## Types of Contributions
49+
50+
- **Bug Fixes:** Improve code reliability and resolve issues.
51+
- **Features:** Add new commands or enhance existing ones.
52+
- **Documentation:** Update or improve the project's documentation.
53+
54+
---
55+
56+
## Code Style
57+
- Use TypeScript with strict typing.
58+
- Write clean, modular code with meaningful function and variable names.
59+
60+
---
61+
62+
## Reporting Issues
63+
If you encounter a bug or have a feature request, create an issue at [GitHub Issues](https://github.com/CodeModule-ir/WakaTime/issues).
64+
65+
---
66+
67+
## Communication
68+
For questions or discussions, contact us at [codemoduletm@gmail.com](mailto:codemoduletm@gmail.com).
69+
70+
We look forward to your contributions!

‎package.json

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
{
2+
"name": "wakatime",
3+
"version": "1.0.0",
4+
"description": "This bot is for CodeModule community Wakatime competition.",
5+
"main": "",
6+
"directories": {
7+
"doc": "docs",
8+
"test": "test",
9+
"docs": "docs"
10+
},
11+
"scripts": {
12+
"test": "",
13+
"build": "tsc"
14+
},
15+
"repository": {
16+
"type": "git",
17+
"url": "git+https://github.com/CodeModule-ir/WakaTime.git"
18+
},
19+
"keywords": [
20+
"wakatime",
21+
"bot",
22+
"telegram-bot",
23+
"telegram",
24+
"codeing"
25+
],
26+
"author": "Mahdi",
27+
"license": "MIT",
28+
"bugs": {
29+
"url": "https://github.com/CodeModule-ir/WakaTime/issues"
30+
},
31+
"homepage": "https://github.com/CodeModule-ir/WakaTime#readme",
32+
"dependencies": {
33+
"@types/chai": "^5.0.1",
34+
"@types/mocha": "^10.0.10",
35+
"@types/node": "^22.10.2",
36+
"chai": "^5.1.2",
37+
"mocha": "^11.0.1",
38+
"ts-node": "^10.9.2",
39+
"typescript": "^5.7.2"
40+
}
41+
}

0 commit comments

Comments
 (0)