https://github.com/celestialaly/martofu
Martofu helps you manage your Dofus sales with a clean UX/UI interface
https://github.com/celestialaly/martofu
dofus dofus-game
Last synced: 5 months ago
JSON representation
Martofu helps you manage your Dofus sales with a clean UX/UI interface
- Host: GitHub
- URL: https://github.com/celestialaly/martofu
- Owner: celestialaly
- Created: 2025-02-18T17:58:02.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-05-30T13:26:06.000Z (about 1 year ago)
- Last Synced: 2025-05-30T18:40:06.303Z (about 1 year ago)
- Topics: dofus, dofus-game
- Language: PHP
- Homepage: https://martofu.fr
- Size: 1.13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Martofu
Martofu helps you manage your Dofus sales with a clean UX/UI interface
## Stack
- Symfony 6.4 with [API Platform 3.4](https://api-platform.com/)
- Vue 3
- [PrimeVue](https://primevue.org/) - UI library
- [PrimeFlex](https://primeflex.org/) - CSS Utility Library
- [Vuelidate](https://vuelidate-next.netlify.app/) - Form validation
- [Pinia](https://pinia.vuejs.org/) - Store
- Docker based on [dunglas/symfony-docker](https://github.com/dunglas/symfony-docker) and updated to handle the frontend
## Development
### Installation
1. If not already done, [install Docker Compose](https://docs.docker.com/compose/install/) (v2.10+)
2. Run `docker compose build --no-cache` to build fresh images
3. Run `SERVER_NAME=martofu.localhost docker compose up -d --wait` to set up the project
4. Run `docker compose down --remove-orphans` to stop the Docker containers.
### Configuration
1. Generate JWT keys with `docker compose exec php php bin/console lexik:jwt:generate-keypair`
2. Set the API URL (see below) in `assets/vue/.env` env file
### Navigate
1. Open `https://martofu.localhost/api` to browse the API docs
2. Open `http://localhost:5173` to access the Vue 3 frontend
The frontend is located under the `/assets/vue` folder.
## Testing
Testing the API is done with PHPUnit:
```sh
docker compose exec php bin/phpunit
```