Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improving the Next.js Example #63

Open
kurosakishigure opened this issue Dec 10, 2024 · 2 comments
Open

Improving the Next.js Example #63

kurosakishigure opened this issue Dec 10, 2024 · 2 comments
Labels
example Add or improve example

Comments

@kurosakishigure
Copy link
Owner

kurosakishigure commented Dec 10, 2024

Example Description

We need to provide a complete Next.js environment so that users can simply clone the project and run pnpm i + katharsis to get started. Additionally, we should improve the related documentation and simplify the files as much as possible.

Rationale

The files in the example are not complete, and we shouldn't assume that users will have these files already. Instead, we should guide users on how to properly configure the necessary files.

Additional Information

We can create a Next.js project using create-next-app, then write the required files and include instructions in the README.md on how to run the project and configure the necessary settings.

@kurosakishigure kurosakishigure added the enhancement New feature or request label Dec 10, 2024
@kurosakishigure
Copy link
Owner Author

We also need to add a unit test and a CI test for the example to ensure it works correctly. Additionally, we should exclude the corresponding build directories when committing to Git.

@kurosakishigure kurosakishigure added example Add or improve example and removed enhancement New feature or request labels Dec 18, 2024
@kurosakishigure
Copy link
Owner Author

We need to update the dependabot.yml file to ensure dependencies in the examples are kept up to date and to verify their compatibility with the latest versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
example Add or improve example
Projects
None yet
Development

No branches or pull requests

1 participant