Skip to content

Commit f3ef0a5

Browse files
PraneethKulukuri26PraneethKulukuri26
committed
feat: Add initial project documentation including contributing guidelines, license, readme, security policy, and code of conduct, and update package version.
1 parent ec138b9 commit f3ef0a5

6 files changed

Lines changed: 175 additions & 1 deletion

File tree

‎CODE_OF_CONDUCT.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4

‎CONTRIBUTING.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Contributing to API Documenter
2+
3+
Thank you for your interest in contributing to API Documenter! We welcome contributions from everyone.
4+
5+
## How to Contribute
6+
7+
1. **Report Bugs**: If you find a bug, please open an issue on GitHub with detailed steps to reproduce.
8+
2. **Suggest Features**: Have a great idea? Open an issue to discuss it.
9+
3. **Pull Requests**:
10+
- Fork the repository.
11+
- Create a new branch for your feature or fix.
12+
- Write clear, documented code.
13+
- Submit a pull request with a detailed description of your changes.
14+
15+
## Development Setup
16+
17+
1. Clone your fork.
18+
2. Run `npm install`.
19+
3. Run `npm run dev` to start the development environment.
20+
21+
## Style Guidelines
22+
23+
- Use TypeScript for all new code.
24+
- Follow existing formatting patterns (ESLint/Prettier rules in the project).
25+
- Write descriptive commit messages.
26+
27+
## Code of Conduct
28+
29+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

‎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) 2026 Praneeth Kulukuri
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.

‎README.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# API Documenter
2+
3+
**API Documenter** is a powerful, self-hosted, offline-first alternative to Postman and Insomnia. It is designed for developers who need a robust API testing environment that works locally by default but scales into a team-oriented platform with secure database synchronization and granular access control.
4+
5+
![API Documenter](resources/icon.png)
6+
7+
## Key Features
8+
9+
- **Offline-First Desktop Environment**: Local performance with no cloud dependency for personal projects.
10+
- **Secure Team Workspaces**: Connect to **PostgreSQL** or **MySQL** for team synchronization via a secure Vercel-hosted proxy.
11+
- **Granular RBAC**: Manage Admins, Editors, and Viewers with folder-level permissions.
12+
- **Advanced Request Engine**: Full support for all HTTP methods, headers, parameters, and bodies.
13+
- **Premium Responsive UI**: A dark-themed, premium design with a custom font-scaling engine for perfect readability on any screen.
14+
- **Automated Updates**: Integrated GitHub update system for seamless version management.
15+
16+
## Built With
17+
18+
- **Core**: Electron, React, TypeScript, Vite
19+
- **Database**: mysql2, pg, Dexie (IndexedDB)
20+
- **Styling**: Vanilla CSS (Custom Variable-based Scaling)
21+
- **Deployment**: Vercel & GitHub Actions
22+
23+
## Getting Started
24+
25+
### Prerequisites
26+
27+
- [Node.js](https://nodejs.org/) (v18 or higher)
28+
- [npm](https://www.npmjs.com/)
29+
30+
### Installation
31+
32+
1. Clone the repository:
33+
```bash
34+
git clone https://github.com/PraneethKulukuri26/API-Documenter.git
35+
cd API-Documenter
36+
```
37+
38+
2. Install dependencies:
39+
```bash
40+
npm install
41+
```
42+
43+
3. Start development server:
44+
```bash
45+
npm run dev
46+
```
47+
48+
4. Build for production:
49+
```bash
50+
npm run build
51+
```
52+
53+
## Contributing
54+
55+
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
56+
57+
## License
58+
59+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
60+
61+
## Security
62+
63+
If you discover any security-related issues, please refer to [SECURITY.md](SECURITY.md) for reporting instructions.

‎SECURITY.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
Specifically, we only support the latest version of API Documenter. Please ensure you are running the most recent release before reporting a vulnerability.
6+
7+
## Reporting a Vulnerability
8+
9+
We take the security of API Documenter seriously. If you believe you have found a security vulnerability, please do NOT open a public issue. Instead, please report it via the following steps:
10+
11+
1. Email a detailed description of the vulnerability to the project maintainer.
12+
2. Provide a proof-of-concept if possible.
13+
3. Allow reasonable time for the maintainer to investigate and resolve the issue before making any information public.
14+
15+
We will acknowledge your report within 48 hours and provide a timeline for a fix.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "api-documenter",
3-
"version": "1.0.14",
3+
"version": "1.0.15",
44
"description": "Self-hosted Postman alternative with folder-level RBAC and offline-first documentation",
55
"main": "./out/main/index.js",
66
"author": "Praneeth Kulukuri",

0 commit comments

Comments
 (0)