magnetico-web/README.md

2.2 KiB

Codeship Status for skobkin/magnetico-web Total Downloads License

Magnetico Web PHP

Magnetico Web is a simple web search interface for magneticod database.

Installation

Application setup is quite simple:

Getting the source code

Using Git

git clone https://skobkin@bitbucket.org/skobkin/magnetico-web.git
cd magnetico-web

Using Composer

composer create-project skobkin/magnetico-web -s dev
cd magnetico-web

Setting file access privileges

Set up appropriate write permissions for var/cache and var/logs.

Installing dependencies (not needed after installation via Composer)

# In developer environment:
composer install
# In production environment
composer install --no-dev --optimize-autoloader

After dependencies installation you may be needed to create .env file (see .env.dist) or set appropriate environment variables for production usage.

Database configuration

See Symfony database configuration documentation for more details.

You must set environment variables for both databases: magneticod's SQLite and magnetico-web's PostgreSQL.

Database schema migration

# Only for 'default' EntityManager (PostgreSQL)
php app/console doc:mig:mig --em=default

User creation

# see --help for more info
# If you don't specify the password it'll be requested from you in the command line
php app/console user:add <your_username> <your_email> [your_password] [--invites=10]

Web assets installation

php app/console assets:install public --symlink

Running using Docker Compose

docker-compose up

# or with image rebuild
docker-compose up --build