1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333
#![doc(test(no_crate_inject))] /*! # actix-web static files as resources support ## Legal Dual-licensed under `MIT` or the [UNLICENSE](http://unlicense.org/). ## Features - Embed static resources in executuble - Serve static resources as directory in `actix-web` - Install dependencies with [npm](https://npmjs.org) package manager - Run custom `npm` run commands (such as [webpack](https://webpack.js.org/)) - Support for npm-like package managers ([yarn](https://yarnpkg.com/)) ## Usage ### Use-case #1: Static resources folder Create folder with static resources in your project (for example `static`): ```bash cd project_dir mkdir static echo "Hello, world" > static/hello ``` Add to `Cargo.toml` dependency to `actix-web-static-files`: ```toml [dependencies] actix-web-static-files = "3.0" [build-dependencies] actix-web-static-files = "3.0" ``` Add build script to `Cargo.toml`: ```toml [package] build = "build.rs" ``` Add `build.rs` with call to bundle resources: ```rust#ignore use actix_web_static_files::resource_dir; fn main() { resource_dir("./static").build().unwrap(); } ``` Include generated code in `main.rs`: ```rust#ignore use actix_web::{App, HttpServer}; use actix_web_static_files; use std::collections::HashMap; include!(concat!(env!("OUT_DIR"), "/generated.rs")); #[actix_rt::main] async fn main() -> std::io::Result<()> { HttpServer::new(move || { let generated = generate(); App::new().service(actix_web_static_files::ResourceFiles::new( "/static", generated, )) }) .bind("127.0.0.1:8080")? .run() .await } ``` Run the server: ```bash cargo run ``` Request the resource: ```bash $ curl -v http://localhost:8080/static/hello * Trying 127.0.0.1:8080... * TCP_NODELAY set * Connected to localhost (127.0.0.1) port 8080 (#0) > GET /static/hello HTTP/1.1 > Host: localhost:8080 > User-Agent: curl/7.65.3 > * Mark bundle as not supporting multiuse < HTTP/1.1 200 OK < content-length: 13 < date: Tue, 06 Aug 2019 13:36:50 GMT < Hello, world * Connection #0 to host localhost left intact ``` ### Use-case #2: package.json - npm managed folder Create folder with static resources in your project (for example `static`): ```bash cd project_dir mkdir static_packages cd static_packages echo '{}' > package.json # install your npm dependencies (here we use fontawesome as an example) npm install --save-dev @fortawesome/fontawesome-free ``` Add generated folder to ignore file of your version control system (here: git): ```bash cd project_dir echo "static_packages/node_modules" >> .gitignore ``` Add `dependencies` and `build-dependencies` in `Cargo.toml` same way as in the first use-case. Add `build.rs` with call to bundle resources: ```rust#ignore use actix_web_static_files::npm_resource_dir; fn main() { npm_resource_dir("./static_packages").unwrap().build().unwrap(); } ``` Include generated code in `main.rs` same way as in the first use-case. Reference resources in your `HTML`: ```html <!DOCTYPE html> <html> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"> <link rel="stylesheet" href="/static/@fortawesome/fontawesome-free/css/all.css"> <script defer src="/static/@fortawesome/fontawesome-free/js/all.js"></script> <title>Hi</title> </head> <body> <i class="fas fa-thumbs-up"></i> </body> </html> ``` ### Use-case #3: package.json - WebPack usage Create folder with static resources in your project (for example `web`), install required packages and webpack: ```bash cd project_dir mkdir -p web/src cd web echo -e "node_modules\ndist" > .gitignore echo '{}' > package.json # install lodash for usage in example npm install --save lodash # install webpack npm dependencies npm install webpack webpack-cli html-webpack-plugin clean-webpack-plugin --save-dev ``` Add `web/webpack.config.js`: ```js const path = require('path'); const { CleanWebpackPlugin } = require('clean-webpack-plugin'); const HtmlWebpackPlugin = require('html-webpack-plugin'); module.exports = { entry: './src/index.js', plugins: [ new CleanWebpackPlugin(), new HtmlWebpackPlugin({ title: 'actix-web-static-files WebPack', }), ], output: { filename: 'main.js', path: path.resolve(__dirname, 'dist'), }, }; ``` Add `web/src/index.js`: ```js import _ from 'lodash'; function component() { const element = document.createElement('div'); element.innerHTML = _.join(['Hello', 'webpack'], ' '); return element; } document.body.appendChild(component()); ``` Modify `web/package.json` by adding "scripts" sections: ```json { "dependencies": { "lodash": "^4.17.15" }, "devDependencies": { "clean-webpack-plugin": "^3.0.0", "html-webpack-plugin": "^3.2.0", "webpack": "^4.41.5", "webpack-cli": "^3.3.10" }, "scripts": { "build": "webpack" } } ``` Add to `Cargo.toml` dependency to `actix-web-static-files` as in the first use case. Add build script to `Cargo.toml` as in the first use case. Add `build.rs` with call to bundle resources: ```rust#ignore use actix_web_static_files::NpmBuild; fn main() { NpmBuild::new("./web") .install().unwrap() .run("build").unwrap() .target("./web/dist") .to_resource_dir() .build().unwrap(); } ``` Include generated code in `src/main.rs`: ```rust#ignore use actix_web::{App, HttpServer}; use actix_web_static_files; use std::collections::HashMap; include!(concat!(env!("OUT_DIR"), "/generated.rs")); #[actix_rt::main] async fn main() -> std::io::Result<()> { HttpServer::new(move || { let generated = generate(); App::new().service(actix_web_static_files::ResourceFiles::new( "/", generated, )) }) .bind("127.0.0.1:8080")? .run() .await } ``` Run the server: ```bash cargo run ``` Request the resource: ```bash $ curl -v http://localhost:8080 * Trying ::1... * TCP_NODELAY set * Connection failed * connect to ::1 port 8080 failed: Connection refused * Trying 127.0.0.1... * TCP_NODELAY set * Connected to localhost (127.0.0.1) port 8080 (#0) > GET / HTTP/1.1 > Host: localhost:8080 > User-Agent: curl/7.64.1 > < HTTP/1.1 200 OK < content-length: 199 < content-type: text/html < etag: "c7:5e403845" < date: Sun, 09 Feb 2020 16:51:45 GMT < <!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>actix-web-static-files WebPack</title> </head> <body> <script type="text/javascript" src="main.js"></script></body> ``` ### Use-case #4: yarn package manager We can use another package manager instead of `npm`. For example, to use [yarn](https://yarnpkg.com/) just add `.executable("yarn")` to `NpmBuild` call: ```rust#ignore use actix_web_static_files::NpmBuild; fn main() { NpmBuild::new("./web") .executable("yarn") .install().unwrap() .run("build").unwrap() .target("./web/dist") .to_resource_dir() .build().unwrap(); } ``` */ include!("impl.rs");