Skip to content

Commit

Permalink
added build instructions and tests
Browse files Browse the repository at this point in the history
  • Loading branch information
eneoli committed Sep 30, 2024
1 parent 5f5f419 commit e1efb26
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,36 @@ Alice is served as a standalone web app, using Rust and WebAssembly for its back

https://github.com/user-attachments/assets/5eb95673-c5f0-4552-8cd1-b251c0f4a62f

# Build Instructions

## Prerequisites

To build Alice, ensure that you have the following installed:

1. **Rust**: Install Rust from [rust-lang.org](https://www.rust-lang.org/).
2. **wasm-pack**: Install wasm-pack from [rustwasm.github.io](https://rustwasm.github.io/wasm-pack/).
3. **NodeJs** and **NPM**: Install NodeJs and NPM from [nodejs.org](https://nodejs.org/).

## Step 1: Build the WebAssembly Binary of the Backend

In the root directory of the project, run the following command to build the WebAssembly binary:

`wasm-pack build`

## Step 2: Build the Frontend

Navigate to the `frontend` directory. Make sure the required dependices are installed by running `npm install`. Then run

`npm run build`

This will bundle the frontend assets and the WebAssembly binary and the final files will be output to the `dist` folder in the project root directory. These can be served by any HTTP server.

# Tests

Alice has a series of autmatic tests. To run them, make sure you are in the project root and run:

`cargo test`

# License
Alice is licensed under the MIT License. See [LICENSE] for the full license text.

Expand Down

0 comments on commit e1efb26

Please sign in to comment.