{"id":22998420,"url":"https://github.com/tablelandnetwork/js-template","last_synced_at":"2025-04-02T13:24:30.452Z","repository":{"id":63585354,"uuid":"566586388","full_name":"tablelandnetwork/js-template","owner":"tablelandnetwork","description":"A typescript template for internal @tableland projects.","archived":false,"fork":false,"pushed_at":"2024-03-12T01:22:48.000Z","size":395,"stargazers_count":2,"open_issues_count":9,"forks_count":0,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-25T17:03:25.568Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tablelandnetwork.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2022-11-16T01:31:14.000Z","updated_at":"2023-07-05T17:41:02.000Z","dependencies_parsed_at":"2024-03-11T19:44:30.592Z","dependency_job_id":null,"html_url":"https://github.com/tablelandnetwork/js-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fjs-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fjs-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fjs-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tablelandnetwork%2Fjs-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tablelandnetwork","download_url":"https://codeload.github.com/tablelandnetwork/js-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246821014,"owners_count":20839340,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-15T06:13:22.032Z","updated_at":"2025-04-02T13:24:30.363Z","avatar_url":"https://github.com/tablelandnetwork.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tableland JavaScript Package Template\n\n[![Review](https://github.com/tablelandnetwork/js-template/actions/workflows/review.yml/badge.svg)](https://github.com/tablelandnetwork/js-template/actions/workflows/review.yml)\n[![License](https://img.shields.io/github/license/tablelandnetwork/js-template.svg)](./LICENSE)\n[![Version](https://img.shields.io/github/package-json/v/tablelandnetwork/js-template.svg)](./package.json)\n[![Release](https://img.shields.io/github/release/tablelandnetwork/js-template.svg)](https://github.com/tablelandnetwork/js-template/releases/latest)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg)](https://github.com/RichardLitt/standard-readme)\n\n\u003e A template for @tableland JavaScript projects\n\n## Table of Contents\n\n- [Table of Contents](#table-of-contents)\n- [Background](#background)\n- [Usage](#usage)\n- [Development](#development)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Background\n\nThis repo contains starter code for building Tableland clients. It contains a basic example using the Tableland SDK ([`@tableland/js-tableland)`](https://github.com/tablelandnetwork/js-tableland)) for creating, writing to, and reading a table as well as Local Tableland ([@tableland/local](https://github.com/tablelandnetwork/local-tableland)) support during development. Both linting (with [`eslint`](https://eslint.org/)) and code formatting (with [`prettier`](https://prettier.io/)) are also included.\n\n## Usage\n\nFirst, clone this repo:\n\n```sh\ngit clone https://github.com/tablelandnetwork/js-template\n```\n\nTo get started, run `npm install` and then `npm run build` command; this will compile the package to the `dist` directory. In `src/index.ts`, there is a basic example of the aforementioned database functionality. A table is created, written to with a single value `hello`, and then exports this value after reading it from the table.\n\n## Development\n\nUse the command `npm run up`, which runs `npm install`, the `build` command, and then spins up a Local Tableland node (the `lt` command). You can then use the output files in the `dist` directory against a local-only Tableland network.\n\nThis project also comes with [`mocha`](https://mochajs.org/) and tests already set up. Running `npm test` will spin up a local node (see: `test/setup.ts`), run the tests against the Local Tableland network, and then shut down the local node upon test completion. Coverage tests with [`c8`](https://github.com/bcoe/c8) are also included, and can be run with `npm run coverage` command to output a coverage report to the `coverage` directory.\n\nThere are also a few other commands you can use:\n\n- `npm run lint`: Lint the codebase with `eslint` (along with the `lint:fix` option).\n- `npm run prettier`: Prettify the code format with `prettier` (along with the `prettier:fix` option).\n- `npm run format`: Both lint and format the codebase with `eslint` and `prettier`, also fixing any issues it can.\n- `npm run clean`: Remove the `dist` and `coverage` folders.\n\n## Contributing\n\nPRs accepted.\n\nSmall note: If editing the README, please conform to the\n[standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## License\n\nMIT AND Apache-2.0, © 2021-2023 Tableland Network Contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftablelandnetwork%2Fjs-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftablelandnetwork%2Fjs-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftablelandnetwork%2Fjs-template/lists"}