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

Update README + Add Example website #17

Merged
merged 3 commits into from
Dec 10, 2024
Merged

Update README + Add Example website #17

merged 3 commits into from
Dec 10, 2024

Conversation

insipx
Copy link
Collaborator

@insipx insipx commented Dec 10, 2024

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new SQLite web application with a post management interface.
    • Added support for WebAssembly (Wasm) integration for SQLite operations.
    • New configuration for security headers in the Netlify setup and run script.
  • Changes

    • Updated the package name from diesel-wasm-sqlite to sqlite-web.
    • Added a new build script for automating the WebAssembly build process.
    • Introduced a new CSS framework for UI components.
  • Bug Fixes

    • Adjusted database connection and initialization across tests to use the new SQLite library.
  • Documentation

    • Updated README and example documentation to reflect new package structure and usage instructions.

@insipx insipx merged commit 0aa5305 into main Dec 10, 2024
1 of 2 checks passed
Copy link

coderabbitai bot commented Dec 10, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve updates to multiple files, primarily focusing on renaming the package from diesel-wasm-sqlite to sqlite-web, along with modifications to associated documentation, configuration files, and examples. A new example package has been introduced, and several files related to the SQLite database management have been added or updated. The .gitignore file has been modified to exclude specific directories, and new scripts and configuration files have been created to support the development and deployment of the project.

Changes

File Path Change Summary
.gitignore Added entry to ignore examples/web-sqlite/pkg/**.
Cargo.toml Renamed package from diesel-wasm-sqlite to sqlite-web, updated description, and added metadata for wasm-pack.
README.md Updated dependency from diesel-wasm-sqlite to sqlite-web, removed Rust code section, and added "Try It Out!" section.
examples/web-sqlite/.vscode/settings.json Added Rust Analyzer configuration settings.
examples/web-sqlite/Cargo.toml Introduced new Cargo.toml for example-sqlite-web package with dependencies and settings.
examples/web-sqlite/README.md Added header # web-sqlite.
examples/web-sqlite/build.sh Created a script to automate the WASM build process.
examples/web-sqlite/css/attribution.txt Added attribution for CSS source.
examples/web-sqlite/css/brutalist.css Introduced comprehensive UI styling for various components.
examples/web-sqlite/css/style.css Defined styles for web application layout and elements.
examples/web-sqlite/diesel.toml Added configuration for Diesel ORM, specifying schema output and migrations directory.
examples/web-sqlite/index.html Created new HTML file for a simple post manager application.
examples/web-sqlite/index.js Introduced main entry point for WASM application.
examples/web-sqlite/migrations/2024-12-09-190250_posts/down.sql Added SQL command to drop the posts table.
examples/web-sqlite/migrations/2024-12-09-190250_posts/up.sql Created SQL migration to establish posts table with defined columns.
examples/web-sqlite/netlify.toml Added security headers for all routes.
examples/web-sqlite/pkg/example_sqlite_web.d.ts Introduced TypeScript declarations for WASM module.
examples/web-sqlite/pkg/example_sqlite_web.js Added WASM interface for SQLite operations.
examples/web-sqlite/pkg/example_sqlite_web_bg.wasm.d.ts Added TypeScript declarations for WASM module interactions.
examples/web-sqlite/pkg/snippets/sqlite-web-90f8afa7b0cd2303/src/js/sqlite3-opfs-async-proxy.js Introduced asynchronous proxy for OPFS operations.
examples/web-sqlite/run.sh Updated script to serve files with security headers.
examples/web-sqlite/src/lib.rs Introduced a web-based example with worker setup for managing posts.
examples/web-sqlite/src/posts.rs Added functionality for managing posts in SQLite using Diesel.
examples/web-sqlite/src/schema.rs Defined schema for the posts table using Diesel ORM.
examples/web-sqlite/src/worker.js Created a Web Worker for initializing WASM functionality.
flake.nix Updated buildInputs to remove and add various packages.
package.json Changed package name and added new dependency in devDependencies.
tests/common/mod.rs Updated references from diesel_wasm_sqlite to sqlite_web.
tests/test/row.rs Modified database connection and initialization to use sqlite_web.
tests/test/web.rs Updated database interaction layer to use sqlite_web.

Poem

In the garden of code, we hop and play,
With sqlite-web leading the way.
From diesel we’ve leapt, with joy we sing,
New features and fixes, oh what joy they bring!
With each little change, our project will bloom,
A bright future ahead, dispelling all gloom! 🐰✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7f0f938 and 8a37c16.

⛔ Files ignored due to path filters (3)
  • examples/web-sqlite/pkg/example_sqlite_web_bg.wasm is excluded by !**/*.wasm
  • flake.lock is excluded by !**/*.lock
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (30)
  • .gitignore (1 hunks)
  • Cargo.toml (2 hunks)
  • README.md (1 hunks)
  • examples/web-sqlite/.vscode/settings.json (1 hunks)
  • examples/web-sqlite/Cargo.toml (1 hunks)
  • examples/web-sqlite/README.md (1 hunks)
  • examples/web-sqlite/build.sh (1 hunks)
  • examples/web-sqlite/css/attribution.txt (1 hunks)
  • examples/web-sqlite/css/brutalist.css (1 hunks)
  • examples/web-sqlite/css/style.css (1 hunks)
  • examples/web-sqlite/diesel.toml (1 hunks)
  • examples/web-sqlite/index.html (1 hunks)
  • examples/web-sqlite/index.js (1 hunks)
  • examples/web-sqlite/migrations/2024-12-09-190250_posts/down.sql (1 hunks)
  • examples/web-sqlite/migrations/2024-12-09-190250_posts/up.sql (1 hunks)
  • examples/web-sqlite/netlify.toml (1 hunks)
  • examples/web-sqlite/pkg/example_sqlite_web.d.ts (1 hunks)
  • examples/web-sqlite/pkg/example_sqlite_web.js (1 hunks)
  • examples/web-sqlite/pkg/example_sqlite_web_bg.wasm.d.ts (1 hunks)
  • examples/web-sqlite/pkg/snippets/sqlite-web-90f8afa7b0cd2303/src/js/sqlite3-opfs-async-proxy.js (1 hunks)
  • examples/web-sqlite/run.sh (1 hunks)
  • examples/web-sqlite/src/lib.rs (1 hunks)
  • examples/web-sqlite/src/posts.rs (1 hunks)
  • examples/web-sqlite/src/schema.rs (1 hunks)
  • examples/web-sqlite/src/worker.js (1 hunks)
  • flake.nix (2 hunks)
  • package.json (2 hunks)
  • tests/common/mod.rs (2 hunks)
  • tests/test/row.rs (1 hunks)
  • tests/test/web.rs (3 hunks)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Experiment)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@insipx insipx deleted the insipx/update-readme branch December 10, 2024 20:53
Copy link

netlify bot commented Dec 10, 2024

Deploy Preview for sqlite-web-example canceled.

Name Link
🔨 Latest commit 8a37c16
🔍 Latest deploy log https://app.netlify.com/sites/sqlite-web-example/deploys/6758aa4d375ed90008a4f77d

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

Successfully merging this pull request may close these issues.

1 participant