Skip to content

use_manual

Jump to bottom
jkutkut edited this page Jun 11, 2023 · 5 revisions

Use Manual:

In this manual, we will guide you step-by-step to set up and use Eatup as efficiently as possible.

Requirements

For an optimal setup and usage experience with Eatup, it's important that your system fulfills the following prerequisites:

  1. Docker: Docker is crucial for setting up and running the Eatup backend. Please ensure that the latest version of Docker is installed on your system. Docker allows for the deployment of the application in a containerized environment, removing the need for managing individual software dependencies.

  2. Internet Connection: An active internet connection is required to fetch the necessary resources, to push and pull updates, and for inter-container communication.

  3. Git: Git is a version-control system used for tracking changes in source code during software development. You'll need Git installed to clone the Eatup repository to your local system.

  4. Java: The Android application for Eatup is developed using Java. Make sure Java 16 or higher is installed on your system to compile and run the Android application.

Application

  1. Building and Installing: The Eatup Android application can be built and installed using Android Studio. With Android Studio and Java 16 installed on your system, open the Eatup application project. Once the project is loaded, select 'Build' > 'Make Project' from the menu to compile the application. Upon successful build, connect your Android device to your system. Ensure that 'USB Debugging' is enabled on your device. From the Android Studio device dropdown menu, select your connected device and hit 'Run' ('Shift + F10') to install the application on your device.

Backend

The process of setting up the backend has been simplified using Docker.

The steps to follow are detailed below:

Start setup service

curl -sSL https://raw.github.com/jkutkutorg/EatUp/main/setup/start.sh | bash

This command will start the Docker container for the setup service. Once done, you can access the setup service at the URL provided in the terminal.

Stop:

First, stop the containers making use of the setup service. Once done, you can stop the setup service using the following command:

docker stop eatup_setup

We trust this user manual will guide you well in setting up and using Eatup. Should you encounter any difficulties or have further questions, please do not hesitate to contact us.

Development:

To develop the project, each service contains a Makefile with the commands needed to build and run, publish and manage the service.

Keep in mind that the logic needed to build a project with this many services is not trivial, requiring some experience with the project. If you want to develop the project, please contact us.

Clone this wiki locally