nearbuilders / create.near

Create App

Starter Kit for Builders

Getting Started

To run locally, first install.

Then, run the command:

yarn dev

This will serve the widgets from http://127.0.0.1:4040/api/loader. (or 8080)

Go to everything.dev/flags and paste this value there.

Once set, see the locally served app at create.near/widget/app.

How To Contribute

Clone the repository, make some changes, open issues, and submit pull requests.

Updates to this repository's main branch automatically deploy to the create.near workspace.

create.near's Issues

Find the best data structure for Create

The ultimate goal is to be able to Create anything in the most modular way possible:

Some concepts:

Core

• Project: a project can consists of many things such as (e.g. documents, widgets, devhub post, board...). A project is like a router that connects everything together.
• Widget: is the simplest thing a project can have.
• Document: a document is another simple thing and it's already implemented in Create, document is basically just a markdown text that can have a widget inside it.

Modifiers

• Template: Each thing (project, widget, document...) will need a template, a template takes the data from the thing and display it as needed.
• Theme: A modifier to templates, usually a CSS to customize the look of the template, can be used to change the colors, logo...

How we are saving data

• Project: ${accountId}/thing/${uuid};
• Widget: ${accountId}/widget/${name};
• Document: ${accountId}/thing/${uuid};
• Template: ${accountId}/widget/${name};
• Theme: ${accountId}/thing/${uuid};

graph TD;
    %% Core
    Project[Project] -->|can include| Document[Document];
    Project -->|can include| Widget[Widget];
    Document -->|can have| Widget;

    %% Modifiers
    Template[Template];
    Theme[Theme];

    %% Data
    Project -->|"`${accountId}/thing/${uuid}`"| SocialDB[(social DB)];
    Widget -->|"`${accountId}/widget/${name}`"| SocialDB[(social DB)];
    Document -->|"`${accountId}/thing/${uuid}`"| SocialDB[(social DB)];
    Template -->|"`${accountId}/widget/${name}`"| SocialDB[(social DB)];
    Theme -->|"`${accountId}/thing/${uuid}`"| SocialDB[(social DB)];

Post Functionality

I want to be able to post/share my creation as an embedding.

App link: https://near.social/devs.near/widget/app

Acceptance Criteria

• Post should not enabled until the document has been saved first
• The path where the document has been saved should be managed in parent's state (think about when we'll want to load an existing document from path
• After a document has been saved and "Post" has been enabled, when I click Post, the path of the document should be prepopulated in the embed content
• After I save a document, modal should close
• After I post a document, modal should close

Note: If you need any test posts, remember to do #test