Skip to content

Latest commit

 

History

History
120 lines (71 loc) · 6.29 KB

README.md

File metadata and controls

120 lines (71 loc) · 6.29 KB

Mintbase.js Templates

Mintbase templates are a compilation of web3 project examples on Near Protocol, providing developers with starter projects and practical use cases. We invite diverse projects to submit demonstrations featuring their technology or developed using ours. Explore demos of existing templates, along with contribution guidelines and documentation to kickstart your journey below!

Templates

Template Demo
Starter Demo
Starter React Vite Demo
AI Chat Demo
AI Minter Demo
Blogchain Demo
Contract Deployer Demo
Minter Demo
Minsta Demo
Marketplace Demo
NFT Stripe Checkout Demo
Token Drop Demo

Contribution Guidelines

We're excited to invite you to contribute templates that showcase the capabilities of web3 projects on the Near Protocol. These templates can serve as starter projects for developers or exemplify specific use cases, inspiring real-world problem-solving.

Here are some instructions to get started:

Starter Guides

Before you start, take a look at these helpful starter guides to familiarize yourself with Mintbase technologies:

Tech Docs

Explore the technologies used in building the current templates:

Contribution Process

  1. Clone the repository: https://github.com/Mintbase/templates
  2. Start a new branch for your template
  3. Create a new folder for your template within the branch
  4. Add a README.MD following the guidelines below
  5. Open a pull request
  6. Ensure deployment works seamlessly

Template Acceptance Criteria

For a greater chance of having your template accepted, it should meet the following criteria:

Originality: The template should feature original code and not be copied from existing sources. Creating something new and unique is highly valued; original contributions take precedence over duplicating existing content with minor modifications.

Code Quality: The code should be clean and easy to understand.

README Format: The template must respect the README format to be indexed by our system.

Usefulness: The example should either serve as a good platform to start a project or represent a use case/solve a problem.

README Template

# Project Name


Add a thumbnail to your project <img src="https://i.imgur.com/s9HSENw.jpg" alt="cover_image" width="0" />

## Description

The first sentence of the description is captured as the intro for the project and will be displayed on the mintbase landing page, use this to grab attention and get someone to click on your template.

Complete project description goes here. Explain the purpose, key features, or anything that provides context from both a business and technical perspective. This section should cover the 'what' and 'why' about the template, catering to users who may be deploying it for their business or developers looking to expand on it. 


[![Demo](https://img.shields.io/badge/Demo-Visit%20Demo-brightgreen)](https://your-live-app/)

[![Deploy](https://img.shields.io/badge/Deploy-Deploy%20Now-blue)](https://your-link-to-deploy-on-vercel/)

**Tooling:**

[![Use Case](https://img.shields.io/badge/Use%20Case-{Use%20Case%20One,%20Use%20Case%20Two}-blue)](#)
[![Tools](https://img.shields.io/badge/Tools-Tool%20One,Tool%20Two-blue)](#)
[![Framework](https://img.shields.io/badge/Framework-NextJS%2014-blue)](#)


## Project Walkthrough

<img src="https://optional-detail-image.png" alt="detail_image" width="500"/>


Explain the project structure, key components, or any significant details. Provide step-by-step instructions for running the project locally.

## Deployment 

Deployment instructions. We include a link to deploy on vercel in every template because it makes it very easy for non developers to spin off their own tempaltes. This section is also a good place to speak about how to configure the project and environment variables.

It should be doable for someone that has no coding experience.

Troubleshooting

Have feedback or perhaps need a hand?

Reach out on our Telegram public developer support channel.

detail_image