Merge pull request #27 from nexoscreation/dev

v0.2.0

.gitignore

@@ -1,5 +1,6 @@
 # Node modules
 node_modules/
+package-lock.json
 
 # TypeScript build output
 /dist/

CHANGELOG.md

@@ -1,15 +1,2 @@
 - up (#26)
 - fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#25)
-- fix (#24)
-- fix (#22)
-- up (#18)
-- fix (#15)

README.md

@@ -1,36 +1,121 @@
-# Nexos Bot
+Here's a detailed and polished `README.md` for your project, tailored to the provided directory structure and guidelines. It includes emojis and formatting to make it appealing for an open-source or public repository.
 
-This is a GitHub App built with [Probot](https://github.com/probot/probot) that automates various GitHub workflows.
-[![CI](https://github.com/nexoscreator/bot-nexos-app/actions/workflows/main.yml/badge.svg)](https://github.com/nexoscreator/bot-nexos-app/actions/workflows/main.yml)
+---
 
-## Install
+# 🚀 GitHub Bot Template
 
-## Setup
+[![Probot](https://img.shields.io/badge/Built%20with-Probot-blue.svg)](https://probot.github.io/)
+[![TypeScript](https://badgen.net/badge/Built%20with/TypeScript/blue)](https://www.typescriptlang.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
 
-1. Install dependencies:
+Welcome to the **GitHub Bot Template**! 🤖  
+This repository provides a robust template for building your own GitHub bot using [Probot](https://probot.github.io/) and TypeScript. The bot automates common workflows like handling issues, pull requests, and notifications while being highly extensible.
 
-    ```bash
-    npm install
-    ```
+---
 
-2. Create a `.env` file with the following variables:
+## 🎯 **Features**
 
-    ```
-    APP_ID=your_app_id
-    PRIVATE_KEY=path_to_your_private_key.pem
-    WEBHOOK_SECRET=your_webhook_secret
-    ```
+- 📝 **Issue Automation**: Automatically triage issues with labels, comments, and assignments.
+- 🔍 **Pull Request Workflow**: Streamline code reviews with reviewer assignment, comments, and more.
+- 📣 **Notifications**: Notify contributors and maintainers about important events.
+- 🔧 **Extensible and Modular**: Easily add new functionality with a service-based architecture.
+- 🌟 **TypeScript Support**: Take advantage of type safety and modern JavaScript features.
 
-3. Start the app:
+---
 
-    ```bash
-    npm start
-    ```
+## 🚀 **Getting Started**
 
-4. Expose your local server using `ngrok`:
+Follow these steps to get your bot up and running:
 
-    ```bash
-    ngrok http 3000
-    ```
+### 1️⃣ **Clone the Repository**
+```bash
+git clone https://github.com/nexoscreation/bot-github-template.git
+cd bot-github-template
+```
 
-5. Update your GitHub App's Webhook URL to the `ngrok` URL.
+### 2️⃣ **Install Dependencies**
+```bash
+npm install
+```
+
+### 3️⃣ **Set Up Environment Variables**
+Create a `.env` file based on the provided `.env.example`:
+```plaintext
+APP_ID=your_app_id
+PRIVATE_KEY=path_to_private_key.pem
+WEBHOOK_SECRET=your_webhook_secret
+GITHUB_TOKEN=your_personal_access_token
+```
+
+### 4️⃣ **Run the Bot**
+```bash
+npm start
+```
+
+### 5️⃣ **Expose the Bot (Optional)**
+Use a tool like [ngrok](https://ngrok.com/) to expose your bot locally:
+```bash
+ngrok http 3000
+```
+
+---
+
+## 🛠️ **Development**
+
+### 🧪 **Testing**
+Write unit and integration tests to ensure the bot works as expected:
+- Unit tests are located in `test/unit/`.
+- Integration tests are located in `test/integration/`.
+
+Run tests with:
+```bash
+npm test
+```
+
+### 🛡️ **Linting**
+Ensure code quality using ESLint:
+```bash
+npm run lint
+```
+
+### 🏗️ **Build**
+Compile the TypeScript code to JavaScript:
+```bash
+npm run build
+```
+
+---
+
+## 👥 **Contributing**
+
+We 💖 contributions! If you'd like to contribute:
+1. Fork the repo and create your branch (`git checkout -b feature/AmazingFeature`).
+2. Commit your changes (`git commit -m 'Add some AmazingFeature'`).
+3. Push to the branch (`git push origin feature/AmazingFeature`).
+4. Open a Pull Request.
+
+For detailed guidelines, see [`CONTRIBUTING.md`](docs/contributing.md).
+
+---
+
+## 📜 **License**
+
+This repository is licensed under the MIT License. See [`LICENSE.md`](LICENSE.md) for more information.
+
+---
+
+## 🌟 **Support**
+
+- Found this template helpful? Give us a ⭐ on GitHub!
+- Questions? Open an issue or join the discussion in [`Discussions`](https://github.com/nexoscreation/bot-github-template/discussions).
+
+---
+
+## 💡 **Acknowledgments**
+
+- Thanks to the [Probot](https://probot.github.io/) team for their amazing framework.
+- Inspired by the open-source community.
+
+---
+
+This `README.md` is clear, engaging, and designed to encourage contributions while providing all necessary setup instructions. Let me know if you'd like additional tweaks! 🚀