Release date plan should be added to the docs

We should add error handling documentation

• GitHub
• LinkedIn

https://vitepress.dev/reference/default-theme-team-page

Motivation

Axe API is a great tool. But it is hard to maintain currently. Because it is written in TypeScript as a framework. We should use the compiled code of Axe API, in another application. Basically, as the Axe API Core Team, we should provide the best development experiences to the developers.

What do we need?

First and foremost, we need good, practical documentation. It must be short as possible. But also it should contain all the details of the development environment.

The following acceptance criteria should be done;

• Easy preparation: Developers should be able to create their development environment in the terminal command.
• Well documented: Developers should be able to access all of the development information. Guides. commands, FAQ, etc.
• Easy testing: Developers should be able to execute all tests (unit, integrations etc.) with one command.

How we implemented it?

• We should use the dev-api repository as the basic template.
• We should use dev-kit name in the repository.
• The project should have all of the commands internally.
• We add full documentation. (Starting in the documentation could be useful to make it super simple)

• static keyword in the fillable and validation sections

• Fixed UserHooks (password_salt, password_hash field, and delete the password property)

import bcrypt from "bcrypt";

const onBeforeInsert = async ({ formData }) => {
  // Genering salt
  formData.password_salt = bcrypt.genSaltSync(10);
  // Hashing the password
  formData.password = bcrypt.hashSync(
    formData.password,
    formData.password_salt
  );
};

export { onBeforeInsert };

• IoC documentation
• Add simple login enpoint

import { IoC } from "axe-api";
import bcrypt from "bcrypt";
import jwt from "jsonwebtoken";

const login = async (req, res) => {
  const { email, password } = req.body;
  const Database = await IoC.use("Database");
  const user = await Database.table("users").where("email", email).first();

  if (!user) {
    return res.status(404).json({
      error: "User not found",
    });
  }

  const userHash = bcrypt.hashSync(password, user.password_salt);
  if (userHash !== user.password) {
    return res.status(404).json({
      error: "User not found",
    });
  }

  const token = jwt.sign({ userId: user.id }, process.env.APP_KEY);
  return res.json({ token });
};

export default async ({ app }) => {
  app.post("/api/login", login);
};

• isLogged middleware example

import jwt from "jsonwebtoken";

export default (req, res, next) => {
  const { authorization } = req.headers;
  if (!authorization) {
    return res.status(401).json({ error: "Unauthorized" });
  }

  try {
    const decoded = jwt.verify(
      authorization.replace("Bearer ", ""),
      process.env.APP_KEY
    );
    req.auth = decoded;
  } catch (error) {
    return res.status(401).json({ error: "Unauthorized" });
  }

  next();
};

It should be AdonisX/Helpers/TriggerHelper or we should define a alias for it.

• Custom Primary Key (#16)
• Auto column detection (#14)

The following issues should be documented;

• #9
• #19
• #17
• #15

Some of features and structures are not documented yet.

• Configuration
• Custom Routes
• Middlewares
• Migrations
• Testing
• Routing documentations: /docs, /docs/routes

We should describe clearly that all the database configurations are the same with Knex.js'.