Skip to content
Snippets Groups Projects
Commit 2807e841 authored by Migushthe2nd's avatar Migushthe2nd
Browse files

Add proper README.md

parent 6468a6ff
No related branches found
No related tags found
No related merge requests found
# HydroMinderApp
## Build Setup
<div align="center">
<p align="center">
<img src="https://i.imgur.com/uBzEyGT.png" width="256" alt="HydroMinder Logo" />
</p>
<h1 align="center">HydroMinder Web App</h1>
<p align="center">A modern hydration tracker for anyone.</p>
</div>
## Description
This is the Web Application.
## Development Requirements
- NodeJS 16.X
- Yarn Package Manager
## Installation
```bash
# install dependencies
$ yarn install
$ yarn
```
## Running the app
Make sure to make a copy of the `.env.example` file as `.env`. The default values will work for development.
For development, it is recommended to also run the [HydroMinder API](https://gitlab.utwente.nl/cs21-32/hydrominder_api).
```bash
# serve with hot reload at localhost:3000
$ yarn dev
......@@ -18,3 +43,27 @@ $ yarn generate
```
For detailed explanation on how things work, check out [Nuxt.js docs](https://nuxtjs.org).
## Test
```bash
# unit tests
$ yarn run test
```
## Publish New Container
```bash
# Login to the registry
docker login registry.gitlab.utwente.nl
# Build with tag 'latest' by default
docker build . --platform linux/arm32/v7 -t registry.gitlab.utwente.nl/cs21-32/hydrominder_app
# Push release
docker push registry.gitlab.utwente.nl/cs21-32/hydrominder_app
```
## License
HydroMinder Web App is [MIT licensed](LICENSE).
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment