Skip to content

vimal-verma/webnfc.org

Repository files navigation

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.js. The page auto-updates as you edit the file.

Contributing

Contributions are welcome! We're excited to see what you can add. Please follow these guidelines to contribute to the project.

Adding a Blog Post

To add a new blog post, follow these steps:

  1. Create a new JSON file in the app/blog/posts/ directory. The filename will be used as the URL slug for the post (e.g., my-new-post.json).

  2. The JSON file should have the following structure:

    {
      "slug": "my-new-post",
      "title": "My New Blog Post",
      "author": "Your Name",
      "date": "YYYY-MM-DD",
      "excerpt": "A short summary of the blog post.",
      "description": "A longer description for SEO purposes.",
      "tags": ["tag1", "tag2"],
      "image": "/previews/blog/my-new-post.png",
      "content": "<p>Your content here, written in HTML.</p>"
    }

Adding a Documentation Page

To add a new documentation page:

  1. Create a new JSON file in the app/documentation/guides/ directory (e.g., new-feature.json).

  2. The JSON file should have the following structure:

    {
      "slug": "new-feature",
      "title": "New Amazing Feature",
      "description": "A brief description of the new feature for SEO.",
      "content": "<h3>Title</h3><p>Your content here, written in HTML.</p>"
    }
  3. Open app/documentation/nav-items.js and add a new entry to the navItems array. The slug should match the filename you just created (without the .json extension). This will automatically add the page to the sidebar navigation.

    const navItems = [
      { slug: 'introduction', title: 'Introduction' },
      // ... other items
      { slug: 'new-feature', title: 'New Amazing Feature' },
    ]

General Contribution Guidelines

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix.
  3. Make your changes and commit them with a clear message.
  4. Push your branch to your fork.
  5. Create a pull request to the main repository.

About

learn, build, and use Web NFC technology directly in your browser.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors