Skip to content
This repository has been archived by the owner on Jan 25, 2024. It is now read-only.

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
floriandejonckheere committed Dec 10, 2023
1 parent 0cf1037 commit 0a9c42c
Showing 1 changed file with 35 additions and 3 deletions.
38 changes: 35 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,46 @@

![Continuous Integration](https://github.com/floriandejonckheere/wattson/workflows/Continuous%20Integration/badge.svg)

Smart energy assistant.
Wattson is a smart energy assistant for the RESPONSE2020 High-Level Energy Management System (HL-EMS) project.

Navigate to [https://wattson.dejonckhee.re](https://wattson.dejonckhee.re) to access the application.

## Installation

Please ensure you have a working [Node.js](https://nodejs.org/en/) environment.
Install the [Yarn](https://yarnpkg.com/) package manager, then install the project dependencies:

```sh
yarn install
```

## Usage

Run the development server:

```sh
yarn
yarn dev
yarn test
```

The application will be available at [http://localhost:5137](http://localhost:5137).
The API server is proxied through the development server to mitigate CORS issues.
To change the API server address, change the IP address in `vite.config.ts`.

## Building

For your convenience, a Dockerfile is provided to build a production-ready image.
The image uses [NGINX](https://www.nginx.com/) to serve the static files, and proxy API requests to the API server.

To build the image, run:

```sh
docker build -t wattson .
```

To run the image, run:

```sh
docker run -p 80:80 wattson
```

## License
Expand Down

0 comments on commit 0a9c42c

Please sign in to comment.