An open API service indexing awesome lists of open source software.

https://github.com/aminoxix/naamkaran-server

न: backbone of namepicker.ai
https://github.com/aminoxix/naamkaran-server

aminos namepicker

Last synced: 3 months ago
JSON representation

न: backbone of namepicker.ai

Awesome Lists containing this project

README

        


Nest Logo

Backbone of [namepicker.ai](https://github.com/aminoxix/namepicker.ai)

## Installation

```bash
$ pnpm install
```

## Running the app

```bash
# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod
```

# Routes

```bash
# /user
create

{
"id": string;
"email": string;
"username": string;
}
```

```bash
# generate username

# /prompt
usernames/create

{
"name": string;
"worded": "ONE" | "TWO";

"userId": string;

"isFav": boolean; # false
"isCombo": boolean; # false
"isUsername": boolean; # true
}
```

```bash
# generate favorite

# /prompt
favorites/create

{
"aim": string;
"name": string;
"hobby": string;
"animal": string;
"background": string;
"worded": "ONE" | "TWO";

"userId": string;

"isFav": boolean; # true
"isCombo": boolean; # false
"isUsername": boolean; # false
}

```

```bash
# generate combinations

# /prompt
combos/create

{
"partner1": string;
"partner2": string;
"gender": string;

"userId": string;

"isFav": boolean; # false
"isCombo": boolean; # true
"isUsername": boolean; # false
}

```

```bash
# /gemini

chat

{
"role": 'user' | 'system' | 'assistant';
"content": string;
"userId": string;
}
```

## 📰 license

> the **naamkaran server** project is released under the [MIT license](https://github.com/aminoxix/naamkaran-backend/blob/main/LICENSE).
developed & maintained by aminos. Copyright 2024 © aminos.


### built with ♡ by

> **profile** @aminoxix  ·  **x** @aminoxix