feat: update package.json with project metadata and keywords

This commit is contained in:
Praveen Thirumurugan
2025-10-18 01:30:54 +05:30
parent 55e834161a
commit 07fad4ec4d
5 changed files with 382 additions and 0 deletions

116
.npmignore Normal file
View File

@@ -0,0 +1,116 @@
# Dependencies
node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*
# Build outputs
dist/
build/
*.tsbuildinfo
# Environment variables
.env
.env.local
.env.development.local
.env.test.local
.env.production.local
# IDE and editor files
.vscode/
.idea/
*.swp
*.swo
*~
# OS generated files
.DS_Store
.DS_Store?
._*
.Spotlight-V100
.Trashes
ehthumbs.db
Thumbs.db
# Logs
logs
*.log
# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Coverage directory used by tools like tools like istanbul
coverage/
*.lcov
# nyc test coverage
.nyc_output
# Optional npm cache directory
.npm
# Optional eslint cache
.eslintcache
# Optional REPL history
.node_repl_history
# Output of 'npm pack'
*.tgz
# Yarn Integrity file
.yarn-integrity
# dotenv environment variables file
.env.test
# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache
# next.js build output
.next
# nuxt.js build output
.nuxt
# vuepress build output
.vuepress/dist
# Serverless directories
.serverless
# FuseBox cache
.fusebox
# DynamoDB Local files
.dynamodb
# TernJS port file
.tern-port
# Stores VSCode versions used for testing VSCode extensions
.vscode-test
# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*
# TypeScript
*.tsbuildinfo
# Git files
.git/
.gitignore
# Documentation
README.md
LICENSE
CONTRIBUTING.md
CODE_OF_CONDUCT.md

52
CODE_OF_CONDUCT.md Normal file
View File

@@ -0,0 +1,52 @@
# Code of Conduct
## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to a positive environment for our community include:
* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall community
Examples of unacceptable behavior include:
* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
## Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at mail@praveent.com. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
Community Impact Guidelines: https://www.contributor-covenant.org/community/guidelines/behavior
Enforcement Procedures: https://www.contributor-covenant.org/community/enforcement
[homepage]: https://www.contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html

172
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,172 @@
# Contributing to LLM Proxy Server
Thank you for your interest in contributing to the LLM Proxy Server! This document provides guidelines and instructions for contributing to the project.
## Table of Contents
- [Getting Started](#getting-started)
- [Development Setup](#development-setup)
- [Making Changes](#making-changes)
- [Submitting Changes](#submitting-changes)
- [Code Style](#code-style)
- [Testing](#testing)
- [Reporting Issues](#reporting-issues)
- [Feature Requests](#feature-requests)
## Getting Started
1. **Fork the repository** on GitHub
2. **Clone your fork** locally:
```bash
git clone https://github.com/praveentcom/llm-proxy-server.git
cd llm-proxy-server
```
3. **Set up your development environment** (see below)
4. **Create a new branch** for your changes:
```bash
git checkout -b feature/your-feature-name
```
## Development Setup
### Prerequisites
- Node.js 18 or higher
- PostgreSQL (for testing the database integration)
- npm or yarn
### Installation
1. Install dependencies:
```bash
npm install
```
2. Set up environment variables:
```bash
cp .env.example .env
# Edit .env with your configuration
```
3. Build the project:
```bash
npm run build
```
### Running in Development Mode
```bash
npm run dev
```
## Making Changes
### Code Style
- Follow TypeScript best practices
- Use meaningful variable and function names
- Add comments for complex logic
- Keep functions focused and single-purpose
- Use proper error handling
### Testing
Currently, the project doesn't have automated tests. When adding new features:
1. Test your changes manually
2. Consider adding integration tests for database operations
3. Test both streaming and non-streaming responses
### Documentation
- Update README.md if you add new features
- Add inline comments for complex code
- Update this CONTRIBUTING.md if you add new development processes
## Submitting Changes
### Pull Request Process
1. **Update your fork** with the latest changes:
```bash
git fetch upstream
git rebase upstream/main
```
2. **Commit your changes** with clear, descriptive messages:
```bash
git commit -m "feat: add support for custom cost models"
```
3. **Push to your fork**:
```bash
git push origin feature/your-feature-name
```
4. **Create a Pull Request** on GitHub with:
- Clear title and description
- Links to any related issues
- Screenshots if applicable
- Testing instructions
### Pull Request Guidelines
- **One feature per PR** - separate features into different PRs
- **Update documentation** - include any necessary changes to README.md
- **Test thoroughly** - ensure your changes work as expected
- **Follow the code style** - maintain consistency with existing code
- **Include tests** - add tests for new functionality if possible
## Code Review
All pull requests will be reviewed by maintainers. Please be responsive to feedback and make requested changes in a timely manner.
## Reporting Issues
### Bug Reports
When reporting bugs, please include:
1. **Environment details**:
- Node.js version
- PostgreSQL version (if applicable)
- Operating system
2. **Steps to reproduce**:
- Clear, step-by-step instructions
- Sample code if applicable
3. **Expected behavior**:
- What should happen
4. **Actual behavior**:
- What actually happens
5. **Error messages**:
- Full error stack traces
### Security Issues
Please report security vulnerabilities privately to mail@praveent.com. Do not create public issues for security problems.
## Feature Requests
We welcome feature requests! Please:
1. **Check existing issues** first to avoid duplicates
2. **Create a new issue** with:
- Clear description of the feature
- Use case and motivation
- Implementation suggestions if you have any
- Potential alternatives you've considered
## Community
- Join our discussions in GitHub issues
- Be respectful and inclusive
- Help others when you can
- Celebrate milestones and successes
## License
By contributing to this project, you agree that your contributions will be licensed under the MIT License.

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 LLM Proxy Server
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:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
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.

View File

@@ -8,6 +8,27 @@
"start": "node dist/proxy.js",
"build": "tsc"
},
"keywords": [
"llm",
"proxy",
"openai",
"api",
"logging",
"cost-tracking",
"postgresql",
"monitoring",
"audit"
],
"author": "LLM Proxy Server Contributors",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/praveentcom/llm-proxy-server.git"
},
"bugs": {
"url": "https://github.com/praveentcom/llm-proxy-server/issues"
},
"homepage": "https://github.com/praveentcom/llm-proxy-server#readme",
"devDependencies": {
"@types/node": "^24.8.1",
"@types/pg": "^8.15.5",