README.md•2.31 kB
# GitHub MCP Tool Manager
A modern web application for managing GitHub tokens and accessing development tools.
## Features
- **GitHub Token Management:** Securely add, update, and validate your GitHub personal access tokens.
- **Tool Dashboard:** Access and manage various development tools integrated with your GitHub account.
- **Responsive UI:** Clean, modern interface with dark mode support.
- **Secure Storage:** Tokens are stored securely on the backend and never exposed to the client.
- **Accessible:** Access all GitHub tools and features in one place.
## Tech Stack
- **Frontend:** React, TypeScript, Tailwind CSS
- **Backend:** Express, Node.js, Drizzle ORM, Zod, MongoDB
## Getting Started
### Prerequisites
- Node.js (v18+ recommended)
- npm or yarn
### Installation
1. **Clone the repository:**
```sh
git clone https://github.com/Rohitkumar0056/GitHub-MCP.git
cd GitHub-MCP
```
2. **Install dependencies:**
```sh
npm install
```
3. **Configure environment variables:**
- Copy `.env.example` to `.env` and fill in your values (see [.env](.env) for reference).
4. **Run the development server:**
```sh
npm run dev
```
### Building for Production
```sh
npm run build
npm start
```
## Project Structure
- `client/` — React frontend (entry: `client/src/main.tsx`)
- `server/` — Express backend API
- `shared/` — Shared types and schema (Zod, Drizzle)
- `components.json`, `tailwind.config.ts`, `postcss.config.js` — UI and styling config
## Usage
1. **Connect your GitHub Token:**
On the landing page, enter your GitHub personal access token.
[How to create a token?](https://github.com/settings/tokens)
2. **Access Tools:**
After connecting, access the dashboard to use available tools.
3. **Update Token:**
Use the dashboard menu to update your GitHub token at any time.
## Development Notes
- **Token Security:** Tokens are never sent to third-party services and are only used for GitHub API requests.
- **Extending Tools:** Add new tools by extending the backend service and updating the frontend dashboard.
## Scripts
- `npm run dev` — Start development servers (client + server)
- `npm run build` — Build client and server for production
- `npm start` — Start production server
## License
MIT