DNA transcription and translation in wasm with rust
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

67 lines
2.5 KiB

  1. <div align="center">
  2. <h1><code>create-wasm-app</code></h1>
  3. <strong>An <code>npm init</code> template for kick starting a project that uses NPM packages containing Rust-generated WebAssembly and bundles them with Webpack.</strong>
  4. <p>
  5. <a href="https://travis-ci.org/rustwasm/create-wasm-app"><img src="https://img.shields.io/travis/rustwasm/create-wasm-app.svg?style=flat-square" alt="Build Status" /></a>
  6. </p>
  7. <h3>
  8. <a href="#usage">Usage</a>
  9. <span> | </span>
  10. <a href="https://discordapp.com/channels/442252698964721669/443151097398296587">Chat</a>
  11. </h3>
  12. <sub>Built with 🦀🕸 by <a href="https://rustwasm.github.io/">The Rust and WebAssembly Working Group</a></sub>
  13. </div>
  14. ## About
  15. This template is designed for depending on NPM packages that contain
  16. Rust-generated WebAssembly and using them to create a Website.
  17. * Want to create an NPM package with Rust and WebAssembly? [Check out
  18. `wasm-pack-template`.](https://github.com/rustwasm/wasm-pack-template)
  19. * Want to make a monorepo-style Website without publishing to NPM? Check out
  20. [`rust-webpack-template`](https://github.com/rustwasm/rust-webpack-template)
  21. and/or
  22. [`rust-parcel-template`](https://github.com/rustwasm/rust-parcel-template).
  23. ## 🚴 Usage
  24. ```
  25. npm init wasm-app
  26. ```
  27. ## 🔋 Batteries Included
  28. - `.gitignore`: ignores `node_modules`
  29. - `LICENSE-APACHE` and `LICENSE-MIT`: most Rust projects are licensed this way, so these are included for you
  30. - `README.md`: the file you are reading now!
  31. - `index.html`: a bare bones html document that includes the webpack bundle
  32. - `index.js`: example js file with a comment showing how to import and use a wasm pkg
  33. - `package.json` and `package-lock.json`:
  34. - pulls in devDependencies for using webpack:
  35. - [`webpack`](https://www.npmjs.com/package/webpack)
  36. - [`webpack-cli`](https://www.npmjs.com/package/webpack-cli)
  37. - [`webpack-dev-server`](https://www.npmjs.com/package/webpack-dev-server)
  38. - defines a `start` script to run `webpack-dev-server`
  39. - `webpack.config.js`: configuration file for bundling your js with webpack
  40. ## License
  41. Licensed under either of
  42. * Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
  43. * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
  44. at your option.
  45. ### Contribution
  46. Unless you explicitly state otherwise, any contribution intentionally
  47. submitted for inclusion in the work by you, as defined in the Apache-2.0
  48. license, shall be dual licensed as above, without any additional terms or
  49. conditions.