passwords/CONTRIBUTING.md at master · simonspa/passwords · GitHub

Set up the local environment

Requirements

Project Setup

Open a shell on your computer and navigate to the projects directory
Run npm run start
Open your browser and type http://localhost/
Allow the connection using a self signed https certificate
Log in with the username admin and the password admin
Run docker exec -u www-data passwords-php /var/www/html/occ app:enable passwords
Run npm install
Run npm run build
You can now access the app

Sample Data

A file with sample data is available in the wiki and can be imported on the backups page.

Helpful commands

npm run start - Start the docker server
npm run stop - Stop the docker server
npm run cron - Execute cron jobs
npm run watch - Create development build of JS/CSS files and watch for changes
npm run build - Create production build of JS/CSS files
npm run build:nightly - Create nightly build of JS/CSS files
docker-compose -f docker-compose.yml -f docker/configs/<service>.yml up -d starts the system with additional services
docker exec -u www-data passwords-php /var/www/html/occ config:system:set loglevel --value=0 --type=int - Set loglevel to info
docker exec -itu www-data passwords-php bash - Open shell in container as www-data
docker exec -it passwords-php bash - Open shell in container as root

Services

https://localhost is Nextcloud (with the app)
http://localhost:8080 is PhpMyAdmin (for the MySQL database)
http://localhost:1080 is MailHog (for Emails)
http://localhost:7070 is Besticon Iconserver (optional)
https://localhost:9090 is PhpLdapAdmin (optional)

First steps