feat: basics

README.md

@@ -1,26 +1,106 @@
+# Golf - AJK Town
+
+[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/mlajkim)
+
+
+## Table of Contents
+
+<!-- TOC -->
+
+- [Golf - AJK Town](#golf---ajk-town)
+  - [Table of Contents](#table-of-contents)
+  - [Overview](#overview)
+  - [For Developers](#for-developers)
+  - [Public Image](#public-image)
+    - [Push image command locally](#push-image-command-locally)
+  - [Depending Libraries](#depending-libraries)
+    - [Luxon](#luxon)
+  - [Package json scripts](#package-json-scripts)
+    - [Upgrade all packages to the latest](#upgrade-all-packages-to-the-latest)
+    - [Format into the standard format](#format-into-the-standard-format)
+  - [About the starter of this project](#about-the-starter-of-this-project)
+    - [Getting Started](#getting-started)
+      - [Run api server](#run-api-server)
+    - [Learn More](#learn-more)
+    - [Deploy on Vercel](#deploy-on-vercel)
+
+<!-- /TOC -->
+
+## Overview
+
+Golf - AJK Town is a simple web application for your golf score management.
+
+https://golf.ajktown.com
+
+
+## For Developers
+- [Developer guide](https://github.com/ajktown/docs/tree/main/dev_golf)
+
+## Public Image
+
+https://hub.docker.com/r/ajktown/golf/tags
+
+
+### Push image command locally
+By default, the GitHub Action will build and push the image to the Docker Hub. If you want to push the image locally, you can use the following commands:
+```sh
+
+docker build -t ajktown/golf:latest .
+docker push ajktown/golf:latest
+
+```
+
+## Depending Libraries
+
+### Luxon
+
+We use Luxon for date and time management of this project.
+
+## Package json scripts
+
+### Upgrade all packages to the latest
+
+Before you upgrade packages of this project
+```bash
+cat ./yarn-latest.log
+# 230215, meaning `$ yarn latest` was run on Feb 15, 2023
+```
+
+### Format into the standard format
+
+This function will fix lint for the repository. Run this every time before doing the PR. It won't pass the lint pipeline test.
+```bash
+yarn inspect
+```
+
+You can upgrade all packages together by
+```bash
+yarn latest
+```
+
+## About the starter of this project
+
 This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
-## Getting Started
+### Getting Started
+
+#### Run api server
+The Wordnote application depends on the ajktown-api server.
+Please install it first. https://github.com/ajktown/api.
+
 
 First, run the development server:
 
 ```bash
-npm run dev
-# or
 yarn dev
 # or
-pnpm dev
-# or
-bun dev
+npm run dev
 ```
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+Open [http://localhost:3200](http://localhost:3200) with your browser to see the result.
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
 
-## Learn More
+### Learn More
 
 To learn more about Next.js, take a look at the following resources:
 
@@ -29,9 +109,8 @@ To learn more about Next.js, take a look at the following resources:
 
 You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
 
-## Deploy on Vercel
+### Deploy on Vercel
 
 The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
 
 Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
-# golf