1
0
mirror of https://github.com/Kovah/LinkAce.git synced 2025-02-22 18:22:26 +01:00
LinkAce/README.md
2019-01-09 21:38:22 +01:00

1.5 KiB

 

A small, selfhosted bookmark manager.

⚠️ This application is still in development and not save to use! ⚠️

 

Development

Setup

I recommend using Docker for development. You need to have Docker installed on your machine. Then, simply run the following command to build your containers.

$ docker-compose up -d --build

Now, install all dependencies from inside the PHP container:

$ docker exec linkace-php bash -c "composer install"

Last step, compile all assets. You need Node with either NPM or Yarn installed.
Node 8 LTS is the minimum version required and recommended to use.

$ npm install
OR
$ yarn install

$ ./node_modules/.bin/grunt build

Working with the Artisan command line

I recommend using the Artisan command line tool in the PHP container only to make sure that the same environment is used. To do so, use the following example command:

$ docker exec linkace-php bash -c "php artisan migrate"

Registering a new user

Currently you can do this by using the command line:

$ docker exec -it linkace-php bash -c "php artisan registeruser [user name] [user email]"

LinkAce is a project by Kovah | Contributors