kay-phos

Web application in development for measuring potassium (K) and phosphorus content in food from your smartphone.

Table of Contents

• Installation
• Usage
• Contributing

Installation

Instructions for OSX

1. Clone the repo:

   git clone https://github.com/kimsh02/kay-phos.git

2. Navigate to the project directory:

   cd kay-phos

3. Make sure you have Go installed:

   brew install go

Instructions for Windows

TODO

Usage

To start the server run the commands below in the root project directory.

go mod tidy

go run cmd/server/main.go

Visit http://localhost:8080/testpage to view the web application.

Additionaly, you can natively compile the web application by running the command below.

go build cmd/server/main.go

To run the executable, do this command.

./main

Contributing

Guidelines for contributing to the project:

• Clone the repo
• Create a new branch (git checkout -b my-branch)
• Submit a pull request