Xanyah Web / Desktop

Warning

This documentation is developer-oriented for contributors. If you are looking for a usage documentation, head to this page: Self-hosting documentation

Requirements

• Node.js >= 22.0
• Yarn >= 1.22

Getting started

# Clone the repo and navigate into it
git clone git@github.com:xanyah/desktop.git && cd desktop

# Install dependencies
yarn

# Run the development server
yarn dev

Project architecture

Dependencies

• Axios: HTTP Client
• React Hook Form: Form management
• React Router: Routing
• React-i18next: Internationalization
• Tailwind: Style management
• TanStack Query: State management
• TanStack Table: Tables management
• Vite: Build tool
• Zod: Data validation

File structure

.github                 # GitHub-related files
public                  # Vite public assets https://vite.dev/guide/build.html#public-base-path
src/
├── api                 # API functions library
├── assets              # Images, fonts etc...
├── components          # Shared components
├── contexts            # React contexts
├── helpers             # Helper functions library
├── hooks               # React hooks
├── i18n/               # i18n config files
│   └── dictionaries/   # i18n localization files
├── layouts             # Layouts used by React Router
├── routes              # Page components
└── types               # Typescript types