Quick Start

Akan.js is a full-stack TypeScript framework that prioritizes designing and implementing actual business code.

To achieve this, technical parts are abstracted as much as possible so that developers do not need to implement them directly.

You can build a type-safe service with minimal code and deploy it to web, mobile, server, and DB infrastructure at the same time.

Installation

Akan.js can be installed with a simple command. Before installation, there's a few requirements.

System Requirements:

First, create a new project using the Akan.js CLI. To create a project, run the following command:

npx create-akan-workspace@latest

When you enter it, the following prompt will be displayed:

what is the name of your organization?: # ex: akancompany

describe your first application to create.: # ex: myapp

akan start myapp --open=true

Now, you can get Nextjs client, React client, and Nestjs Server.

Client control

You can edit page with Next.js App Router interface. For example, you can edit the default page(/) as follows.

You can edit the default template to write Hello Akan.js as follows.

// File: apps/<my-app>/app/[lang]/(<my-app>)/(public)/page.tsx

export default function Page() {

  // You can edit page with Next.js interface.

  return (

    <div className="flex h-screen w-screen items-center justify-center text-2xl">

      Hello Akan.js! 🎉

    </div>

);

Next.js page is available at http://localhost:4200 and it works with server-side rendering, which is optimized for web-based operations.

React page is available at http://localhost:4201 and it works with client-side rendering, which is optimized for mobile app-based operations.

Hello Akan.js! 🎉

Server control

You can edit the main.ts to log Hello Akan.js as follows. It is the entry point file for the Node.js server.

// File: apps/<my-app>/main.ts

import { Logger } from "@akanjs/common";

...other imports

const bootstrap = async () => {

  // ...other code

  Logger.info("Hello Akan.js! 🎉");

};

void bootstrap();

Nest.js server is running at http://localhost:8080. You can see the log in the terminal.

# In terminal window

...

...

[Backend] 33852 - 06/22/2025, 14:54:36 PM     LOG  🚀 Server is running on: http://[::1]:8080 +3579ms

[App] 33852 - 06/22/2025, 14:54:36 PM    INFO  Hello Akan.js! 🎉 +3581ms

...

...

Released under the MIT License

Official Akan.js Consulting onAkansoft

System managed bybassman