Introduction to Arkos

Arkos is a powerful, fast and lightweight backend framework built on top of Express.js and Prisma that simplifies RESTful API development. It automates common backend tasks while providing the flexibility developers need for custom solutions.

Key Features

Automatic API Generation

Instantly create RESTful API routes for Prisma models.

Built-in Authentication

Supports JWT-based authentication with effortless setup.

Express Middlewares

Pre-configured security, request parsing, and error handling.

Built-in Data Validation

Using class-validator and class-transformer or zod.

Prisma Integration

Seamless connection with Prisma ORM for database management.

File Upload & Optimization

Efficient image, video, docs, raw-file handling.

Interceptors Middlewares

Tailor as you want, intercept, customize your middleware flow.

Nodemailer Integration

Seamless nodemailer integration for sending emails.

Swagger API Documentation

Seamless generate an api documentation.

Why Arkos?

Arkos eliminates repetitive setup tasks and boilerplate code, allowing developers to focus on building features rather than infrastructure. It's perfect for:

Rapid RESTful API Development
Enterprise Solutions
MVPs and Prototypes
Full-Stack Applications
Anything You Can Do With Express

Origin of the Name

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

As Simples As This

JavaScript
TypeScript

// src/app.js
const arkos = require("arkos");

arkos.init({ port: 8000 });

// src/app.ts
import arkos from "arkos";

arkos.init({ port: 8000 });

Ready to build your API? Let's get started! 🚀

Next Steps

Getting Started - Set up your first Arkos project
Project Structure - See the the Arkos project structure
How Does It Works - Learn about Arkos behind the scene work
Core Concepts - Catch up with arkos core

Key Features​