README.adoc

NCU Punch Clock

Table of Contents

• Introduction
• Getting Started
• Deployment

Introduction

NCU Punch Clock (NPC) is a web application for National Central University students to schedule their part-time jobs, and NPC will automatically clock in and out for you, eliminating concerns about forgetting to do so.

Getting Started

1. Clone the repository

   git clone https://github.com/FOBshippingpoint/ncu-punch-clock.git
   cd ncu-punch-clock

2. Install dependencies

   maven install

3. Run the application

   maven spring-boot:run

Deployment

1. Build the application

   # Build a jar file named like `ncu-punch-clock-0.0.1-SNAPSHOT.jar` in `target` directory
   maven package

2. Configure environment variables

   The default environment variables are listed in src/main/resources/application.properties. But you should not use them in production, configure your own environment variables instead. You can found example in src/main/resources/.env.example. Create a .env file and replace the values that fit your needs.

   set -a
   source .env
   set +a

3. Run the application

   java -jar ncu-punch-clock-0.0.1-SNAPSHOT.jar

📎	You may want to use systemd to manage NPC. See Spring Documentation for more information.