Nekomata API

Nekomata API is a simple Node.js and TypeScript-based API server. This project is structured to provide a solid foundation for building scalable APIs using modern JavaScript/TypeScript practices.

Features

TypeScript: Strongly typed JavaScript, providing better tooling and readability.
Node.js: Fast and scalable server-side runtime.
Modular Structure: Easily extendable with well-defined modules and services.

Prerequisites

Make sure you have the following installed on your machine:

Node.js (v14+ recommended)
Yarn (optional, you can use npm instead)

Installation

Clone the repository:

git clone https://github.com/your-username/nekomata-api.git
cd nekomata-api

Install the dependencies:

yarn install

Useful Commands

Enter Docker Mysql: sudo docker exec -it mysql bash
Create new Sequelize Model (and migration for it): npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string

Available Scripts

1. Development Mode

To run the project in development mode with hot-reloading:

yarn dev

2. Build for Production

To compile the project into JavaScript (production build):

yarn build

The compiled files will be located in the api/ folder.

3. Serve Production Build

After building the project, you can serve it in production mode:

yarn serve

Project Structure

bbb src/              # Source code
b   bbb controllers/  # API controllers
b   bbb services/     # Business logic
b   bbb routes/       # API routes
b   bbb models/       # Data models (if using a database)
b   bbb utils/        # Utility functions
b   bbb index.ts      # Application entry point
bbb api/             # Compiled production code
bbb package.json      # Project dependencies and scripts
bbb tsconfig.json     # TypeScript configuration
bbb README.md         # Project documentation

License

nekomata-api neon

This project was bootstrapped by create-neon.

Building nekomata-api neon

Building nekomata-api neon requires a supported version of Node and Rust.

To run the build, run:

$ npm run build

This command uses the @neon-rs/cli utility to assemble the binary Node addon from the output of cargo.

Exploring nekomata-api neon

After building nekomata-api neon, you can explore its exports at the Node console:

$ npm i
$ npm run build
$ node
> require('.').hello()
'hello node'

Available Scripts

In the project directory, you can run:

`npm install`

Installs the project, including running npm run build.

`npm run build`

Builds the Node addon (index.node) from source, generating a release build with cargo --release.

Additional cargo build arguments may be passed to npm run build and similar commands. For example, to enable a cargo feature:

npm run build -- --feature=beetle

`npm run debug`

Similar to npm run build but generates a debug build with cargo.

`npm run cross`

Similar to npm run build but uses cross-rs to cross-compile for another platform. Use the CARGO_BUILD_TARGET environment variable to select the build target.

`npm test`

Runs the unit tests by calling cargo test. You can learn more about adding tests to your Rust code from the Rust book.

Project Layout

The directory structure of this project is:

nekomata-api neon/
bbb Cargo.toml
bbb README.md
bbb src/
|   bbb lib.rs
bbb index.node
bbb package.json
bbb target/

Entry	Purpose
`Cargo.toml`	The Cargo manifest file, which informs the `cargo` command.
`README.md`	This file.
`src/`	The directory tree containing the Rust source code for the project.
`lib.rs`	Entry point for the Rust source code.
`index.node`	The main module, a Node addon generated by the build and pointed to by `"main"` in `package.json`.
`package.json`	The npm manifest file, which informs the `npm` command.
`target/`	Binary artifacts generated by the Rust build.