docs: Update README.md with completed tasks and future plans #484

Workflow file for this run

	name: CI

	on:
	push:
	branches: [main]
	pull_request:

	env:
	# app
	APP_PORT: 8080
	APP_ENV: 'development'
	APP_URL: 'localhost'
	APP_ADMIN_EMAIL: '[email protected]'
	APP_API_KEY_SECRET: 'notify'
	APP_SECRET_SALT: 'notify'

	# redis
	REDIS_HOST: 'localhost'
	REDIS_PORT: 6379
	REDIS_PASSWORD: 'password'

	# session
	SESSION_STORE_PREFIX: 'deez'
	SESSION_SECRET: 'nutz'
	SESSION_DOMAIN: 'localhost' # needs to be domain.com without http or https

	# database
	DB_PORT: 5432
	DB_HOST: 'localhost'
	DB_USERNAME: 'postgres'
	DB_PASSWORD: 'postgres'
	DB_DATABASE: 'database'

	# github
	GITHUB_REDIRECT_URL: 'http://localhost/oauth/github/redirect'
	GITHUB_CLIENT_ID: 'deez'
	GITHUB_CLIENT_SECRET: 'nutz'

	# email
	EMAIL_HOST: 'mailhot'
	EMAIL_PORT: 1025
	EMAIL_ALIAS: '[email protected]'
	EMAIL_AUTH_EMAIL: '[email protected]'
	EMAIL_AUTH_PASS: 'password'

	# twilio
	TWILIO_ACCOUNT_SID: ''
	TWILIO_AUTH_TOKEN: ''
	TWILIO_FROM_PHONE_NUMBER: ''
	TWILIO_PHONE_NUMBER: ''

	# discord
	DISCORD_WEBHOOK_URL: ''

	jobs:
	unit-test:
	name: Unit tests
	runs-on: ubuntu-latest

	services:
	postgres:
	image: postgres:14
	env:
	POSTGRES_USER: postgres
	POSTGRES_PASSWORD: postgres
	POSTGRES_DB: database
	ports:
	- 5432:5432
	options: >-
	--health-cmd pg_isready
	--health-interval 10s
	--health-timeout 5s
	--health-retries 5

	redis:
	image: redis
	ports:
	- 6379:6379
	options: >-
	--health-cmd "redis-cli ping"
	--health-interval 10s
	--health-timeout 5s
	--health-retries 5

	strategy:
	matrix:
	node-version: [22.x]

	steps:
	- uses: actions/checkout@v4
	- name: Use Node.js ${{ matrix.node-version }}
	uses: actions/setup-node@v4
	with:
	node-version: ${{ matrix.node-version }}
	cache: 'npm'

	- name: Create .env file from .env.ci
	run: cp .env.ci .env

	- name: Install dependencies
	run: npm i

	- name: Migrate dev database
	run: npm run db:prepare:dev

	- name: Test codes
	run: npm run test:coverage

	browser-test:
	timeout-minutes: 60
	name: Browser tests
	runs-on: ubuntu-latest

	services:
	postgres:
	image: postgres:14
	env:
	POSTGRES_USER: postgres
	POSTGRES_PASSWORD: postgres
	POSTGRES_DB: database
	ports:
	- 5432:5432
	options: >-
	--health-cmd pg_isready
	--health-interval 10s
	--health-timeout 5s
	--health-retries 5

	redis:
	image: redis
	ports:
	- 6379:6379
	options: >-
	--health-cmd "redis-cli ping"
	--health-interval 10s
	--health-timeout 5s
	--health-retries 5

	strategy:
	matrix:
	node-version: [22.x]

	steps:
	- uses: actions/checkout@v4
	- name: Use Node.js ${{ matrix.node-version }}
	uses: actions/setup-node@v4
	with:
	node-version: ${{ matrix.node-version }}
	cache: 'npm'

	- name: Create .env file from .env.ci
	run: cp .env.ci .env

	- name: shell
	run: ls -la

	- name: Install dependencies
	run: npm ci

	- name: Install Playwright Browsers
	run: npx playwright install --with-deps

	- name: Migrate dev database
	run: npm run db:prepare:dev

	- name: Run Playwright tests
	run: npx playwright test

	- uses: actions/upload-artifact@v4
	if: always()
	with:
	name: playwright-report
	path: playwright-report/
	retention-days: 30

	lint:
	name: ESLint
	runs-on: ubuntu-latest

	strategy:
	matrix:
	node-version: [22.x]

	steps:
	- uses: actions/checkout@v4
	- name: Use Node.js ${{ matrix.node-version }}
	uses: actions/setup-node@v4
	with:
	node-version: ${{ matrix.node-version }}
	cache: 'npm'

	- name: Install dependencies
	run: npm i

	- name: Lint codes
	run: npm run lint

	format:
	needs: [lint, unit-test, browser-test]
	name: Prettier format
	runs-on: ubuntu-latest

	permissions:
	contents: write

	strategy:
	matrix:
	node-version: [22.x]

	steps:
	- uses: actions/checkout@v4
	- name: Use Node.js ${{ matrix.node-version }}
	uses: actions/setup-node@v4
	with:
	node-version: ${{ matrix.node-version }}
	cache: 'npm'

	- name: Install dependencies
	run: npm i

	- name: Format codes
	run: npm run format

	- name: Commit changes
	uses: stefanzweifel/git-auto-commit-action@v4
	with:
	commit_message: 'style: format codes'
	env:
	GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

	deploy:
	needs: [unit-test, browser-test, lint, format]
	name: Deploy to Production
	runs-on: ubuntu-latest
	if: github.event_name == 'push' && github.ref == 'refs/heads/main'

	environment:
	name: production
	url: https://notify.jaw.dev/

	steps:
	- name: Check out repository
	uses: actions/checkout@v4

	- name: Set up Docker Buildx
	uses: docker/setup-buildx-action@v2

	- name: Login to Container Registry
	uses: docker/login-action@v2
	with:
	registry: ghcr.io
	username: ${{ github.repository_owner }}
	password: ${{ secrets.GH_TOKEN }}

	- name: Preset Image Name
	run: echo "IMAGE_URL=$(echo ghcr.io/${{ github.repository_owner }}/${{ github.event.repository.name }}:$(echo ${{ github.sha }} \| cut -c1-7) \| tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV

	- name: Build and push Docker Image
	uses: docker/build-push-action@v4
	with:
	context: .
	file: ./Dockerfile.prod
	push: true
	tags: ${{ env.IMAGE_URL }}
	cache-from: type=gha
	cache-to: type=gha,mode=max

	- name: Deploy Image to Server
	uses: caprover/[email protected]
	with:
	server: '${{ secrets.CAPROVER_SERVER }}'
	app: '${{ secrets.APP_NAME }}'
	token: '${{ secrets.APP_TOKEN }}'
	image: ${{ env.IMAGE_URL }}

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Update README.md with completed tasks and future plans #484

Workflow file

docs: Update README.md with completed tasks and future plans #484

Jobs

Run details

Workflow file for this run