https://github.com/patiencemanzen/appwrite-postapi

Platform that simplifies the process of creating, organizing, and maintaining APIS and postman-apis documentation. It helps teams collaborate effectively, improves documentation consistency, and ensures that information is easily accessible to all devs, project manager and DevOps.
https://github.com/patiencemanzen/appwrite-postapi

api appwrite cypress documentation eslint patienceman postman typescript vue

Last synced: 5 months ago
JSON representation

Platform that simplifies the process of creating, organizing, and maintaining APIS and postman-apis documentation. It helps teams collaborate effectively, improves documentation consistency, and ensures that information is easily accessible to all devs, project manager and DevOps.

• Host: GitHub
• URL: https://github.com/patiencemanzen/appwrite-postapi
• Owner: patiencemanzen
• Created: 2023-05-30T15:40:55.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-07-14T14:11:35.000Z (almost 2 years ago)
• Last Synced: 2025-01-09T05:45:40.067Z (6 months ago)
• Topics: api, appwrite, cypress, documentation, eslint, patienceman, postman, typescript, vue
• Language: CSS
• Homepage: https://postapis.netlify.app
• Size: 7.83 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# POSTAPI | patienceman

Platform that simplifies the process of creating, organizing, and maintaining 

APIS and postman-apis documentation. It helps teams collaborate effectively, improves documentation consistency, 

and ensures that information is easily accessible to all devs, project manager and DevOps.

## Export postman collection guide:

To work with postapi and postman, you need to first export your custom collection from postman:

![Screenshot 2023-06-15 at 8 47 33 AM](https://github.com/manirabona-programer/Appwrite-postapi/assets/55847682/0104de61-9704-406b-9404-4f34d66819f5)

![Screenshot 2023-06-15 at 8 48 19 AM](https://github.com/manirabona-programer/Appwrite-postapi/assets/55847682/7758c1bd-0cb3-411b-bee3-61a9e7df3de6)

## import the collection in PostAPI:

head to your [postapi account](https://postapis.netlify.app) on dashboard and set organization, projects and ready to import the collection and kickstart your documentation



### Manage Your projects and activate one



### Import your custom collection



I believe that documentation is crucial for knowledge transfer within development teams and organizations. When developers move to new roles or leave the company, well-documented (codes, APIS, docs) and processes ensure that their knowledge is not lost. It enables smooth succession planning and minimizes disruptions in project development.

## Recommended IDE Setup

[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).

## Customize configuration

See [Vite Configuration Reference](https://vitejs.dev/config/).

## Project Setup

```sh

npm install

```

### Compile and Hot-Reload for Development

```sh

npm run dev

```

### Compile and Minify for Production

```sh

npm run build

```

### Run Unit Tests with [Vitest](https://vitest.dev/)

```sh

npm run test:unit

```

### Run End-to-End Tests with [Cypress](https://www.cypress.io/)

```sh

npm run build

npm run test:e2e # or `npm run test:e2e:ci` for headless testing

```

### Lint with [ESLint](https://eslint.org/)

```sh

npm run lint

```