Skip to content

Commit

Permalink
readme upd
Browse files Browse the repository at this point in the history
  • Loading branch information
alcalbg committed Dec 1, 2023
1 parent 20f6e46 commit c99cf87
Showing 1 changed file with 2 additions and 39 deletions.
41 changes: 2 additions & 39 deletions README.md
Expand Up @@ -121,52 +121,15 @@ docker run -it --rm --name filegator-dev-env \
$(docker build -q - < Dockerfile.dev) \
bash -c 'composer install && npm i && npm run serve'
```
Build fontend into dist/ folder:

Build the fontend into `filegator/dist/` folder:
```
docker run -it --rm --name filegator-dev-env \
-v "$PWD":/usr/src/app -w /usr/src/app \
$(docker build -q - < Dockerfile.dev) \
bash -c 'npm run build'
```

## Project setup for development (Linux)

You must have `git`, `php`, `npm`, and `composer` installed.

```
git clone https://github.com/filegator/filegator.git
cd filegator
cp configuration_sample.php configuration.php
chmod -R 775 private/
chmod -R 775 repository/
composer install --ignore-platform-reqs
npm install
npm run build
```


## Compiles and hot-reloads

The following command will launch backend and frontend on ports 8081 and 8080:

```
npm run serve
```
Once everything is ready visit: `http://localhost:8080`


## Run tests & static analysis

Testing requires xdebug, php-zip and sqlite php extensions.

```
vendor/bin/phpunit
vendor/bin/phpstan analyse ./backend
npm run lint
npm run e2e
```


## Deployment

Set the website document root to `filegator/dist` directory. This is also known as 'public' folder.
Expand Down

0 comments on commit c99cf87

Please sign in to comment.