Skip to content

codebendervt/canvas

Repository files navigation

The Canvas Of The Web

  • This works best with parcel as it is a super compiler
  • Dcoumentation is really limted at the moment

Requirements

if you note any new ones create a PR updating the readme.md file

  • React
  • TailwindCss

How to use

Have a .npmrc file with the following inside

//npm.pkg.github.com/:_authToken=PesonalAccessToken
@codebenderhq:registry=https://npm.pkg.github.com

Packages required

the canvas project itself installed like so, note the latest version here

npm install @codebenderhq/sdk@0.1.1

you will need to have tailwindcss installed on your local project for the components to work

npm install  -D tailwindcss@latest postcss@latest autoprefixer@latest

create a .postcsrcc file or a json version of it if you prefer that, and paste the following in it

{
  "plugins": {
    "autoprefixer": {},
    "tailwindcss" : {},
 
  }
}

if you want to customize you tailwind configuration have a look here

you will also need react installed

npm install react

Getting Started

This is still in development so the imports are limited

when working with tailwindcss you need to include tailwind into your CSS , import the below in your root js file to include the CSS in your project

@codebenderhq/sdk/src/theme/{themeName}/style/index.css

if there are some custom components you would like to use private to you you can create your own CSS file including tailwindcss like so

Local Playground

more to be shared soon

Contributions

The best place to get your hands dirty from new to old you are all welcomed

Since this is a new project, and is still early, anything and everything is a great first thing to do, as time goes this will be updated to be more accessible without having to ask questions

Contact

if you run into any problems from setup to just a stupid question

you can contact @codebenderhq

FYI: first time maintainer