aircodelabs / hydrogen

The serverless framework creates web servers that can run anywhere.

Hydrogen

The serverless framework creates web servers that can run anywhere.

Features

• 🐇 Rapid development with Hot Module Replacement (HMR) 🔥
• 📦 Supports CommonJS (.js .cjs), ES modules (.mjs), and TypeScript (.ts) functions out of the box.
• 🧸 Requires almost zero configurations.
• 🗄️ Comes with a built-in, ready-to-use text database and file API.
• 📁 Follows intuitive directory structure conventions.
• 🤏 Written in Pure JavaScript with a sleek and minimalist design.
• ⚡️ Optimized for runtime performance, regardless of development or production environments.
• 🧊 Compatible and capable of running your app seamlessly on the AirCode platform.

Getting Started

1. Create an aircode app

npx create-aircode-app@latest my-aircode-app && cd my-aircode-app

2. Install dependencies and run

npm i && npm start

Directory Structure

The default project directory structure is very simple.

├──functions # put your function api here.
│  └── hello.js # http://localhost:3000/hello
├──public # put your static resources here.
│  └── favicon.ico # http://localhost:3000/public/favicon.ico
└── package.json

Build Cloud Functions

You can easily build your function api in ./functions directory.

1. With *.js or *.cjs

// myfun.js
const aircode = require('aircode');

module.exports = async function(params, context) {
  console.log('Received params:', params);
  return {
    message: 'Hi, AirCode.'
  };
}

2. Or with *.mjs

import aircode from 'aircode';

export default async function (params, context) {
  console.log('Received params:', params);
  return {
    message: 'Hi, AirCode.',
  };
};

3. Or with *.ts

import aircode from 'aircode';

export default async function (params: any, context: any) {
  console.log('Received params:', params);
  return {
    message: 'Hi, AirCode.',
  };
};

Simply visit your built functions with http://localhost:3000/<your_func_name>.

And visit your static resources with http://localhost:3000/public/<your_static_file>.

Documentation

• Cloud Function
• The Database
• The File API

Configurations

There are a few options that you can pass through process.env.

process.env.AC_FAAS_ROOT = process.env.AC_FAAS_ROOT || 'functions';
process.env.AC_PUBLIC_DIR = process.env.AC_PUBLIC_DIR || 'public';
process.env.AC_PORT = process.env.AC_PORT || 3000;

Integration

Integration Hydrogen with AirCode online

hydrogen's Issues

为啥 npx create-aircode-app 生成的代码并不依赖 aircode

这个aircode 好奇怪， 为啥 npx create-aircode-app 生成的代码并不依赖 aircode, 但是 functions 里的代码还要依赖 const aircode = require("aircode") ， 而且把这个依赖去掉也能运行？

关于数据库相关的问题

这个项目是必须依赖aircode云平台吗还是它是一个类似airecode云平台的开源？

数据库这块按照airecode文档执行的话

import aircode from 'aircode';

export default async function (params, context) {
  const dbs = aircode.db.table('persons');
  // Use `save` to add a new record
  const result = await dbs.save({
    name: 'Micheal',
    age: 28,
  });
  // const result = await dbs.where({ name: 'Micheal' }).find();

  return {
    result
  };
};

以上在hydroge中运行是访问api是没有任何信息的，数据是能正常在本地插入（如下图）

关于post请求参数序列化问题

已修复

Questions about file downloads

• windows10
• Hydrogen:latest

Through aircode's upload API, files can be uploaded, but there will be problems with downloading, prompting no such file.

The results are as follows

import aircode from 'aircode';

export default async function (params, content) {
    // Get the file from multipart/form-data params, `myFile` is the key
    const { _id } = params;

    // You can do some permission checks before uploading
    // ...
    
    // Upload the file to AirCode
    const res = await aircode.files.download({
        // Replace the _id value with your file's
        _id
    });
    // return the URL of file
    return {
        res,
    };
}

2023-10-19 Additional information

I still think there is something wrong with using the airecode api for file upload and download in Hydrogen.

If you do not change the data when uploading and saving, only modify the download method as follows
https://github.com/AirCodeLabs/Hydrogen/blob/34d9a016cd7461d4f12ec053399846ad4b925437/src/runtime/file-service.js#L103C7-L103C76

filepath = path.resolve(process.env.AC_FAAS_ROOT, filepath.slice(1));

filepath = process.env.AC_FAAS_ROOT + filepath.slice(2)