/alternative-frontend-react

An alternative client for the capyfile project

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

CapyFile Alternative Web Client

Github Actions Integration Status Github Actions Tagging Status Github Actions Release Status
code style: prettier linter: eslint testing: playwright UI library: shadcn/ui

Preview 🖼️

CapyFile client preview

Differences with the official client 🤔

  • This client is built with shadcn/ui which contributes to having consistent styles across the application and improves the user experience and accessibility (Ex: Keyboard navigation ⌨️).

  • All features are implemented in this client ✨.

  • All the domain use cases are tested with end-to-end tests using playwright 🧪.

  • Some features are implemented using React Hooks (Eg: filesReducer.tsx) and the Context API, which makes the code more readable and maintainable without the need to use a state management library like Redux ⚛️.

  • This project has a custom Navigation Implementation based on a Queue, which allows the user to navigate through the folders using a "go back" button ⏪.

Development 🛠️

  1. Clone the project
git clone https://github.com/PedroChaparro/unofficial-frontend-react.git
cd ./unofficial-frontent-react
  1. Install dependencies
pnpm i
  1. Run the the necessary services
docker-compose up
  1. Start the development server
pnpm dev

Make sure you follow the Contribution Guidelines and update or create new tests under the e2e folder.