mirror of
https://github.com/YunoHost/yunohost-portal.git
synced 2024-09-03 20:06:23 +02:00
Update development instructions
This commit is contained in:
parent
b2911f79b9
commit
c3e1caf77d
1 changed files with 15 additions and 8 deletions
23
README.md
23
README.md
|
@ -2,16 +2,23 @@
|
|||
|
||||
- This is a based on [Nuxt v3](https://nuxt.com/)
|
||||
|
||||
### Setup
|
||||
### Develop (using Docker)
|
||||
|
||||
- I'm doing all this from inside a YunoHost LXC
|
||||
- You may want to open port 3000 (or disable the firewall) to access the dev server
|
||||
- Install Docker
|
||||
- It should boil down to adding something like `deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian bullseye stable` to your apt list
|
||||
- and then `apt update && apt install docker-ce`
|
||||
- Install Docker-compose
|
||||
- `pip3 install docker-compose`
|
||||
- Inside your Yunohost LXC/ynh-dev/???, make sure the new `yunohost-portal-api` is running and corresponding route is in nginx config
|
||||
- Add something like `NUXT_PUBLIC_API_IP=yolo.test` inside a `.env` which you may need to create. Replace `yolo.test` with you test domain or test IP (eg your ynh-dev LXC)
|
||||
- `docker-compose up -d` : will rebuild the docker on the first time, then launch it
|
||||
- Check `docker-compose logs -f` : should show that nuxt/nitro is building stuff then serving it on port 3000
|
||||
- Access `127.0.0.1:3000` from your browser
|
||||
|
||||
### Develop (manual / directly on your host machine)
|
||||
|
||||
- Same as for Docker, this assumes that `yunohost-portal-api` does run, is configured in nginx, and you may have to set `NUXT_PUBLIC_API_IP` in `.env` which you may have to create
|
||||
- You'll need NodeJS 18.14 (or higher)
|
||||
- And `yarn`
|
||||
- Run `yarn install`
|
||||
- Also make sure the new yunohost-portal-api is running and corresponding route is in nginx config
|
||||
|
||||
### Dev
|
||||
|
||||
- Run `yarn dev`
|
||||
- Access `http://1.2.3.4:3000/`
|
||||
|
|
Loading…
Reference in a new issue