darrenmeehan / photos

Frontend for a Photo Browsing Web App

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Photos

This application is in its very early stages.

I'm using it as a side project to develop my Rust skills.

It's not recommended for use yet. But feel free to check it out and send any feedback my way!

Project Goal

Store your photos online securely and privately.

How to install

npm install

How to run in debug mode

# 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

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

How to run unit tests

# 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.

Why such a complicated setup?

I believe Web Assembly is the future of the web. I also believe Rust has some interesting concepts with its strict compiler and its strict typing. I'm hoping rust-wasm handles a lot of the pain in setup.

wasm-pack

https://rustwasm.github.io/docs/wasm-pack/introduction.html

About

Frontend for a Photo Browsing Web App


Languages

Language:Rust 83.1%Language:JavaScript 12.9%Language:HTML 4.0%