Code Monkey home page Code Monkey logo

website's People

Contributors

akku1139 avatar armster15 avatar erik-beus avatar fzn0x avatar heysolomon avatar hideokamoto-stripe avatar htunnicliff avatar insumanth avatar kleenkanteen avatar kristianfreeman avatar leocabeza avatar mathuraditya724 avatar michahuhn avatar mmmknt avatar monsterdeveloper avatar morinokami avatar mstibbard avatar nicoplyley avatar paiji avatar probir-sarkar avatar ryuapp avatar sor4chi avatar soulusions avatar soviut avatar spenceradolph avatar tao-s avatar thatonebro avatar un-focused avatar watany-dev avatar yusukebe avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

website's Issues

method override plugin

Hi, I have written a hono-method-override plugin, it's similar to a middleware, but it's not(middleware api can not implement this feature).

So, where should I put the link in the document to let the community quickly find it

Cache API Not Supported on Deno Deploy

While attempting to use the Cache API for caching HTTP responses on Deno Deploy, it was discovered that the caches variable is unavailable in the deployment environment.

Need to add a note on the documentation making it clear that it is not supported.

Add documentation for JWT based utilities

Developers can create and verify their own JWTs using Hono Jwt utilities. However, this is not documented.

I'd be happy to add this documentation. I'd suggest adding it as follows:

  • API
    • Utilities
      • JWT
        • encode
        • decode
        • verify

Please let me know if you'd like me to proceed and confirm where you'd want this in the docs.

v3

TODOs for "v3"

Specify the extension of the file that uses jsx with jsx.

tip block section in 'code' text color same match

While I was browsing 'JWT Auth middleware' documentation, I found that tip block section there was 'code' type of text color is same as background color of tip block. it was confused what was written. Kindly try to add white background color of 'code' type text and keep same text color as it is.

image

Broken link for "Building a larger application" in RPC guide

Problem

The link for "Building a larger application" in the RPC section of the docs should point to the "Building a larger application" section on the "Best Practices" page, but points to a section/fragment on the "RPC" guide that does not exist!

Relevant Link: https://hono.dev/guides/rpc#using-with-larger-applications

Screenshot

Screenshot 2024-02-10 at 16 16 13

Solution

I think this can be fixed by updating the link in the docs here to point to /guides/best-practices#building-a-larger-application.

Happy to make this quick fix or let someone else handle! Thanks for the awesome docs!

Stacks RPC code example

The hono stacks page showing RPC react example with posts and gets is really useful showing how hono and RPC with tanstack query can be used for frontend and backend.

However to get the example working I had to change the way the mutation worked by adding mutationFN. Could be worth updating the page?

Current code example

const mutation = useMutation<
    InferResponseType<typeof $post>,
    Error,
    InferRequestType<typeof $post>['form']
  >(
    async (todo) => {
      const res = await $post({
        form: todo,
      })
      return await res.json()
    },
    {
      onSuccess: async () => {
        queryClient.invalidateQueries({ queryKey: ['todos'] })
      },
      onError: (error) => {
        console.log(error)
      },
    }
  )

Changed to

const mutation = useMutation<
    InferResponseType<typeof $post>,
    Error,
    InferRequestType<typeof $post>['form']
  >({
    // Mutation function
    mutationFn: async (todo) => {
      const res = await $post({
        form: todo,
      });
      return await res.json()
    },

    // Success handler
    onSuccess: async () => {
      queryClient.invalidateQueries({ queryKey: ['todos'] })
    },

    // Error handler
    onError: (error: Error) => {
      console.error(error)
    },
  })

Hono on Azure Functions

Hey everyone! I made an adapter for Azure Functions.
I think it would be great to add an "Azure Functions" page to the Getting Started section.

I noticed that most of the adapters/middlewares/helpers are from the official "hono" account.
Would you allow for my library to be part of the docs, or is there another way we could do this? @yusukebe

Thanks!

Improve explanation for hono client components

These additions could help:

1: explain which runtimes are currently supported
2: add example code that ties together server side components with client components
3: give a robust example of how to use the render() function. How can I insert my client components into other components?
4: explain how it's possible to access the document object in the example code
5: explain how changing the tsconfig to "hono/jsx/dom" affects the other jsx components you've made. (Using bun & vscode, this causes linting errors for all my existing jsx components)

Overall, it just needs a more thorough explanation of setup and use because it currently has no examples of how to utilize hono client components along with regular server components. (is this even possible?)

Service worker documentation and example

From what I can tell, Hono can be used for an offline web app in a service worker (even hosted from a web server that only serves static assets).

Can that get officially documented and demonstrated through an example?

I found this, which is magical indeed, but I think a simpler example that doesn't use the same service worker between Cloudflare and browser but a simple browser example would be sufficient and beneficial (your magical example could be linked to it included too).

I think officially documenting on the site and linking to a Hono example in the example repo with other examples would help demonstrate that Hono really can be ran in most any JS runtime and that it can be used to power an offline only web app (installed while online but then requires no Internet connection for usage).

v4

We have to add the documents for v4 until Feb, 9th. Let's work on v4 branch.

Documentation Enhancements

List of sections we are planning to add

  • Snippets (Like Bun Document)
    • file upload #72
    • using OpenAPI
      • with Swagger UI
    • create middlewares
  • Best practices

Branch to create documentation for v4

I would like to write a feature update for hono v4. However, it is difficult to merge this into the main branch, so if you could create a next or v4 branch soon, I can get started on this.

Improve documents for Built-in middleware

Currently, documents for Built-in middleware are incomplete. The explanation is too simple, and no description of "options".

I've written the page for Pretty JSON Middleware: https://honojs.dev/docs/builtin-middleware/pretty-json/

We will complete the other middleware pages using this as a reference.

Tasks for v3.2

Working on v3.2 branch.

  • "Document how to use Hono with Vercel & NodeJS runtime" honojs/node-server#46
  • app.routerName
  • app.mount()
  • LinearRouter
  • PatternRouter
  • Presets
  • Cookie Middleware
  • hostname routing
  • basePath()
  • Who is using Hono?
  • Node Server 18+
  • Use-cases

Sample Dockerfile for Node.js

When deploying Hono to a production environment with the Node.js runtime, I expect to deploy it in a container.

So it would be nice to have a sample Dockerfile in the documentation.

Add `honojs` install script on an existing project

Current state

By visiting Get Started > Bun, I did not see any command (script) to install from an existing project.

Expected state

Split this site (Section 2. Setup) into 2 parts, the first part presents a new project by using bun creat project by using bun create hono my-app. The second part presents using bun install ....

Screenshot

Screenshot 2024-06-01 104147
I have a folder already, just need to bun install hono.. instead

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.