expressots / expresso-site-doc

ExpressoTS Official Documentation 🐎

ExpressoTS Official Documentation

Everything you need to know to build applications with ExpressoTS
Explore the docs »

Let's discuss · Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
3. Contributing
4. Support the project
5. License

About The Project

ExpressoTS is a Typescript + Node.js lightweight framework for quick building scalable, easy to read and maintain, server-side applications 🐎

Getting Started

• Here is our Site
• You can find our Documentation here
• Checkout our First Steps documentation
• Our CLI Documentation

Contributing

Welcome to the ExpressoTS community, a place bustling with innovative minds just like yours. We're absolutely thrilled to have you here! ExpressoTS is more than just a TypeScript framework; it's a collective effort by developers who are passionate about creating a more efficient, secure, and robust web ecosystem. We firmly believe that the best ideas come from a diversity of perspectives, backgrounds, and skills.

Why Contribute to Documentation?

• Share Knowledge: If you've figured out something cool, why keep it to yourself?
• Build Your Portfolio: Contributing to an open-source project like ExpressoTS is a great way to showcase your skills.
• Join a Network: Get to know a community of like-minded developers.
• Improve the Product: Help us fill in the gaps, correct errors, or make complex topics easier to understand.

Ready to contribute?

• Contributing Guidelines
• How to Contribute
• Coding Guidelines

Support the project

ExpressoTS is an independent open source project with ongoing development made possible thanks to your support. If you'd like to help, please consider:

• Become a sponsor on GitHub
• Follow the organization on GitHub and Star ⭐ the project
• Subscribe to the Twitch channel: Richard Zampieri
• Join our Discord
• Contribute submitting issues and pull requests
• Share the project with your friends and colleagues

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

expresso-site-doc's Issues

Add in the controller section information about multiple middlewares in the http method decorators

Guidelines

• I agree to follow this project's Contributing Guidelines.

Is there an existing issue for this?

• I have searched the existing issues

Existing Issues

N/A

Current behavior

Currently ExpressoTS supports passing an array of middleware in the HTTP method in each controller, allowing adding middleware specifically to a route.

Let's assume that the method post in the user/create routing will have middleware compression and body-parser. Middleware1 and Middleware2 below represents that idea, in which specific routes can have specific middleware avoiding adding the middleware globally to all routes.

We need a topic in the Controller Section that describes this functionality in ExpressoTS

@controller("/user/create")
export class UserCreateController extends BaseController {
    constructor(private createUserUseCase: CreateUserUseCase) {
        super();
    }

    @Post("/", middleware1, middleware2)
    execute(
        @body() payload: CreateUserRequestDTO,
        @response() res: Response,
    ): CreateUserResponseDTO {
        return this.callUseCase(
            this.createUserUseCase.execute(payload),
            res,
            StatusCode.Created,
        );
    }
}

Steps to reproduce

N/A

Expected behavior

A section called Controller Middleware that described the functionality mentioned above in the current behavior section

Package version

N/A

Node.js version

N/A

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

Adjust the methods name on Controller section

Guidelines

• I agree to follow this project's Contributing Guidelines.

Is there an existing issue for this?

• I have searched the existing issues

Existing Issues

N/A

Current behavior

Controller and parameter decorators are not correct. They are shown the previous version of ExpressoTS
Here is incorrect page

INCORRECT

In this page decorators page, contain all the controller and parameters decorators that are correct and should be used in the above page.

CORRECT

Steps to reproduce

N?A

Expected behavior

Replace the decorators in the Controller section by the ones in the Decorators section

Package version

N/A

Node.js version

N/A

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

Translate the doc to Spanish

Guidelines

• I agree to follow this project's Contributing Guidelines.

Is there an existing issue for this?

• I have searched the existing issues

Existing Issues

No response

Current behavior

There is no documentation translated to Spanish

Steps to reproduce

N/A

Expected behavior

New doc version in Spanish

Package version

N/A

Node.js version

N/A

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

Modifying the image of Application Life Cycle hooks to match the Light Mode Page

Guidelines

• I agree to follow this project's Contributing Guidelines.

Is there an existing issue for this?

• I have searched the existing issues

Existing Issues

N/A

Current behavior

For dark mode the Application Life Cycle hook is very visible as demonstrated below

However, is not matching the light mode of the page as show below

The idea is to create the same image with the same content that matches the doc light mode

Steps to reproduce

N/A

Expected behavior

An image that show the same workflow, content matching the Light mode

Package version

N/A

Node.js version

N/A

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

Translate the Doc to Japanese

Guidelines

• I agree to follow this project's Contributing Guidelines.

Is there an existing issue for this?

• I have searched the existing issues

Existing Issues

N/A

Current behavior

No documentation translate to Japanese

Steps to reproduce

N/A

Expected behavior

Documentation translated to Japanese

Package version

N/A

Node.js version

N/A

In which operating systems have you tested?

• macOS
• Windows
• Linux

Other

No response

Add search mechanism in the doc

• Add Algolia DocSearch in the Doc
• Refs: https://www.algolia.com/developers/code-exchange/integrate-docusaurus-with-algolia-docsearch/

feat: support dark theme

I was reading the docs on mobile, and noticed that the documentation is in a blinding white theme.

I think that's not a hard thing to do, but very useful for our tired eyes.