Docwiz aka Documentation Wizard

Docwiz ile rest apilerinizin postman output dosyalarını, readme dosyalarına çevirebilirsiniz.

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Built With

• React
• Geist

Getting Started

Proje Client dosyasında, tamamlanmadı fakat npm install ve npm start ile çalıştırabilirsiniz.

Installation

1. Clone the repo

   git clone https://github.com/muratdemirci/docwiz/tree/main/client

2. Install NPM packages

   npm install

3. Enter your API in config.js

   npm start

Roadmap

Version 1.0

• Postman json output dosyasını ekrana yazdır

  • Api dökümantasyonları nasıl olur, araştır
  • Bir şema belirle, buna göre db'ye kaydedilsin
  • api endpointlerinin klasörlenmesi (düşüneyim bunu)

• Rest apiye başla

  • Dosya upload edecek (belki?)
  • Gelen dosya output unu insert endpointi üzerinden veritabanına yazdır
  • Endpointler için description alanı

• README dosyalarının oluşturulması

  • dosya otomatik oluşturulur
  • önizlenir
  • düzenlenir
  • download edilir

yukarıdakilere vakit kalmadığı için olayı UI'da halletmeyi denedim :)

(back to top)

Contributing

Burası güncellenecek

(back to top)

License

Distributed under the Apache License Version 2.0. See LICENSE.txt for more information.

(back to top)

Contact

Murat demirci- @deusmur - [email protected]

Project Link: https://github.com/muratdemirci/docwiz

(back to top)