https://github.com/textileio/textile-cookies
Official Textile Cookiecutter Templates
https://github.com/textileio/textile-cookies
Last synced: over 1 year ago
JSON representation
Official Textile Cookiecutter Templates
- Host: GitHub
- URL: https://github.com/textileio/textile-cookies
- Owner: textileio
- License: mit
- Created: 2019-03-06T21:28:01.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-04-04T00:04:19.000Z (over 7 years ago)
- Last Synced: 2025-01-29T21:51:19.093Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 375 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Textile Cookiecutter Templates _(textile-cookies)_
[](https://textile.io)
[](https://slack.textile.io)
> Official Textile Cookiecutter Templates
Join us on our [public Slack channel](https://slack.textile.io/) for news, discussions, and status updates.
## Background
[Textile](https://www.textile.io) provides encrypted, recoverable, schema-based, and cross-application data storage built on [IPFS](https://github.com/ipfs) and [libp2p](https://github.com/libp2p). We like to think of it as a decentralized data wallet with built-in protocols for sharing and recovery, or more simply, **an open and programmable iCloud**.
The reference implementation of Textile is [written in Go](https://github.com/textileio/textile-go), and can be compiled to various platforms, including mobile (Android/iOS) and desktop/server (OSX, Windows, Linux, etc). The library in this repo is designed to help support things like browser-based Textile apps, Node.js apps, and other use-cases.
## Install
Make sure you have the [cookiecutter app installed](https://cookiecutter.readthedocs.io/en/latest/installation.html) on your system:
```sh
# If you have Python installed
pip install --user cookiecutter
# Or, if you don't want to use Python...
brew install cookiecutter # OSX only
pipsi install cookiecutter # Linux/OSX only
sudo apt-get install cookiecutter # Debian/Ubuntu
```
## Usage
To create a new Textile-based project, simply call:
```sh
cookiecutter gh:textileio/textile-cookies
```
By default, this will create a simple Node.js script. You can also specify one of our templates directly via the `--checkout` flag (`react` or `electron`).
Then its simply a matter of:
```sh
cd appname
yarn install
yarn start
```
Now you can start editing the app code and making it your own. Check out the generated `README.md` file for details.
## Maintainer
[Carson Farmer](https://github.com/carsonfarmer)
## License
[MIT](./LICENSE)