|
1 | | -# API Documenter |
| 1 | +<div align="center"> |
| 2 | + <img src="resources/icon.jpg" alt="API Documenter Logo" width="150" /> |
2 | 3 |
|
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 | + <h1>API Documenter</h1> |
4 | 5 |
|
5 | | - |
| 6 | + <p> |
| 7 | + <strong>A powerful, self-hosted, offline-first alternative to Postman and Insomnia.</strong> |
| 8 | + </p> |
6 | 9 |
|
7 | | -## Key Features |
| 10 | + [](https://opensource.org/licenses/MIT) |
| 11 | + [](http://makeapullrequest.com) |
| 12 | +</div> |
| 13 | + |
| 14 | +--- |
| 15 | + |
| 16 | +**API Documenter** 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. |
| 17 | + |
| 18 | +## ✨ Key Features |
8 | 19 |
|
9 | 20 | - **Offline-First Desktop Environment**: Local performance with no cloud dependency for personal projects. |
10 | 21 | - **Secure Team Workspaces**: Connect to **PostgreSQL** or **MySQL** for team synchronization via a secure Vercel-hosted proxy. |
|
13 | 24 | - **Premium Responsive UI**: A dark-themed, premium design with a custom font-scaling engine for perfect readability on any screen. |
14 | 25 | - **Automated Updates**: Integrated GitHub update system for seamless version management. |
15 | 26 |
|
16 | | -## Built With |
| 27 | +## 🛠️ Built With |
17 | 28 |
|
18 | 29 | - **Core**: Electron, React, TypeScript, Vite |
19 | 30 | - **Database**: mysql2, pg, Dexie (IndexedDB) |
20 | 31 | - **Styling**: Vanilla CSS (Custom Variable-based Scaling) |
21 | 32 | - **Deployment**: Vercel & GitHub Actions |
22 | 33 |
|
23 | | -## Getting Started |
| 34 | +## 🚀 Getting Started |
24 | 35 |
|
25 | 36 | ### Prerequisites |
26 | 37 |
|
| 38 | +Ensure you have the following installed on your local machine: |
27 | 39 | - [Node.js](https://nodejs.org/) (v18 or higher) |
28 | 40 | - [npm](https://www.npmjs.com/) |
29 | 41 |
|
30 | | -### Installation |
| 42 | +### Installation & Setup |
31 | 43 |
|
32 | | -1. Clone the repository: |
| 44 | +1. **Clone the repository:** |
33 | 45 | ```bash |
34 | 46 | git clone https://github.com/PraneethKulukuri26/API-Documenter.git |
35 | 47 | cd API-Documenter |
36 | | - ``` |
37 | | - |
38 | | -2. Install dependencies: |
| 48 | +2. **Install dependencies:** |
39 | 49 | ```bash |
40 | 50 | npm install |
41 | | - ``` |
42 | | - |
43 | | -3. Start development server: |
| 51 | +3. **Run the application:** |
44 | 52 | ```bash |
45 | 53 | npm run dev |
46 | | - ``` |
47 | | - |
48 | | -4. Build for production: |
| 54 | +4. **Build for production:** |
49 | 55 | ```bash |
50 | 56 | 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. |
| 57 | +5. **Deploy to Vercel:** |
| 58 | + ```bash |
| 59 | + npm run deploy |
0 commit comments