Wordnote

Table of Contents

• Wordnote
  • Table of Contents
  • Overview
  • For Developers
  • Public Image
    • Push image command locally
  • Depending Libraries
    • Luxon
  • Package json scripts
    • Upgrade all packages to the latest
    • Format into the standard format
  • About the starter of this project
    • Getting Started
      • Run api server
    • Learn More
    • Deploy on Vercel

Overview

Wordnote is the second generation project produced by AJK Town, or AJ Kim. It was renamed after "Wordy".

https://wordnote.ajktown.com

For Developers

• Developer guide

Public Image

https://hub.docker.com/r/ajktown/wordnote/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:

docker build -t ajktown/wordnote:latest .
docker push ajktown/wordnote: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

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.

yarn inspect

You can upgrade all packages together by

yarn latest

About the starter of this project

This is a Next.js project bootstrapped with create-next-app.

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:

yarn dev
# or
npm run dev

Open http://localhost:3002 with your browser to see the result.

Learn More

To learn more about Next.js, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.