https://github.com/smudger/walk-the-dog-2

https://github.com/smudger/walk-the-dog-2

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/smudger/walk-the-dog-2
• Owner: smudger
• License: mit
• Created: 2024-11-06T15:05:06.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-06T16:17:45.000Z (about 2 months ago)
• Last Synced: 2024-11-06T16:28:46.834Z (about 2 months ago)
• Language: Rust
• Size: 2.81 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## How to install

```sh

npm install

```

## How to run in debug mode

```sh

# Builds the project and opens it in a new browser tab. Auto-reloads when the project changes.

npm start

```

## How to build in release mode

```sh

# Builds the project and places it into the `dist` folder.

npm run build

```

## How to run unit tests

```sh

# Runs tests in Firefox

npm test -- --firefox

# Runs tests in Chrome

npm test -- --chrome

# Runs tests in Safari

npm test -- --safari

```

## What does each file do?

* `Cargo.toml` contains the standard Rust metadata. You put your Rust dependencies in here. You must change this file with your details (name, description, version, authors, categories)

* `package.json` contains the standard npm metadata. You put your JavaScript dependencies in here. You must change this file with your details (author, name, version)

* `webpack.config.js` contains the Webpack configuration. You shouldn't need to change this, unless you have very special needs.

* The `js` folder contains your JavaScript code (`index.js` is used to hook everything into Webpack, you don't need to change it).

* The `src` folder contains your Rust code.

* The `static` folder contains any files that you want copied as-is into the final build. It contains an `index.html` file which loads the `index.js` file.

* The `tests` folder contains your Rust unit tests.