Add project base

This commit is contained in:
Aj - Thomas
2022-04-25 00:11:32 +02:00
parent c2c4f3a9d1
commit 56b42668a8
11 changed files with 568 additions and 124 deletions

View File

@@ -1,39 +1,13 @@
# Mantine Next Template
# HomePage, a home page for your home server
## What is HomePage ?
HomePage is a web page for your home server, it provides a user friendly interface to access docker containers or other services.
## How to use HomePage ?
### 1. Install HomePage
### 2. Configure HomePage
### 3. Start HomePage
Get started with Mantine + Next with just a few button clicks.
Click `Use this template` button at the header of repository or [follow this link](https://github.com/mantinedev/mantine-next-template/generate) and
create new repository with `@mantine` packages. Note that you have to be logged in to GitHub to generate template.
## Features
This template comes with several essential features:
- Server side rendering setup for Mantine
- Color scheme is stored in cookie to avoid color scheme mismatch after hydration
- Storybook with color scheme toggle
- Jest with react testing library
- ESLint setup with [eslint-config-mantine](https://github.com/mantinedev/eslint-config-mantine)
## npm scripts
### Build and dev scripts
- `dev` start dev server
- `build` bundle application for production
- `export` exports static website to `out` folder
- `analyze` analyzes application bundle with [@next/bundle-analyzer](https://www.npmjs.com/package/@next/bundle-analyzer)
### Testing scripts
- `typecheck` checks TypeScript types
- `lint` runs ESLint
- `prettier:check` checks files with Prettier
- `jest` runs jest tests
- `jest:watch` starts jest watch
- `test` runs `jest`, `prettier:check`, `lint` and `typecheck` scripts
### Other scripts
- `storybook` starts storybook dev server
- `storybook:build` build production storybook bundle to `storybook-static`
- `prettier:write` formats all files with Prettier
# Notes
## On page load ?
# Ping all connected services to check if they are up and running
# If not, display a warning message
# Update the bubble of each connected service