README.md

poneglyph

🥞 An a standard documentation for every project

Poneglyph is a quick starter kit README.md for documentation in your every project.

Frontend UI	Backend API
web.adeka.id	api.adeka.id

Table of Contents

• 🌐 Links
• 🏆 Use Cases
• 📚 References
• 🧱 Features
• 🎨 Designs
• 👤 Authors
• 🤝 Contribution
• 📝 License

🌐 Links 🔝

The applications with corresponding repositories:

• Backend API
  • backend-api
• Frondend UI
  • frontend-ui

Documentation

• Specifications for Web (Markdown)
• Specifications for API (Markdown)
• Ideation (Miro)
• Web Sitemap (Whimsical)

🏆 Use Cases 🔝

• Main contents
  • Detail of main content per use case
• Authentication and authorization
  • Detail of auth and authorization
• User account
  • Detail of user account
• Other
  • Empty state
  • 404 page

🧱 Features 🔝

Current Features

by examples

• Highly opiniated structure to start a project faster
  • Focused on JavaScript, Node.js, React, and Express ecosystem
  • Later possible with TypeScript too
• Simple and good-looking user interface (UI) and quick user experience (UX)
  • Ideation powered by Miro and Whimsical

Some stack alternatives are listed in each repository's documentation.

Later Features 🔝

by examples

• Offline-first mode powered by Progressive Web App (PWA) approach
• Role-based access control (RBAC)
  • Powered by CASL
• Alternative on REST API with query language
  • Powered by GraphQL API and Prisma

📚 References 🔝

There are some references and guide to develop this project

• TailwindCSS
• RealWorld.io
  • react-redux-realworld
• Golang Starter
• User Interface Design Guidelines

🎨 Designs 🔝

• Web Design (Figma)
• Mobile Design (Figma)

👤 Authors 🔝

• Ivan Fadila (@ffadilaputra)
• Aldi Taher (@naufaldi)

📝 License 🔝

See LICENSE

This template inspired by

• Handbook by evilfactory
• Catamyst