Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

arkos

uanela2.1kMIT1.1.67-betaTypeScript support: included

The Express & Prisma Framework For RESTful API

auto API routes, TypeScript package, API generator, authentication, email service, error handling, file upload, image optimization, Prisma integration, customizable API, auto routing, file upload routes, dynamic API routes, Prisma ORM, image upload, API middleware

readme

Header Image

Arkos

The Express And Prisma Framework For RESTful API

Used to simplify the development of a secure and scalable RESTful API with minimal configuration, allowing developers to focus on what really matters for the business

Features

  • 🚀 Automatic API Generation - Instantly create RESTful routes from Prisma models
  • 🔐 Built-in Authentication - JWT-based authentication with minimal setup
  • ⚡ Express Middlewares - Pre-configured security, parsing, and error handling
  • 🛡️ Data Validation - Using class-validator/class-transformer or zod
  • 💠 Prisma Integration - Seamless database management with relation fields support
  • ⬆️ File Upload & Optimization - Efficient handling of images, videos, and documents
  • 👨‍💻 Interceptors Middlewares - Customize request/response flow with hooks
  • ✉️ Nodemailer Integration - Easy email sending functionality
  • 📝 Swagger API Documentation - Automatically generate API documentation

BETA VERSION

Documentation

For detailed documentation, visit our official docs.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For questions or issues, please open a GitHub issue or contact Uanela Como.

The name "Arkos" comes from the Greek word "ἀρχή" (Arkhē), meaning "beginning" or "foundation", reflecting our goal of providing a solid foundation for backend development.