75 lines
2.5 KiB
Markdown
75 lines
2.5 KiB
Markdown
[](https://app.codeship.com/projects/295041)
|
|
[](https://packagist.org/packages/skobkin/magnetico-web)
|
|
[](https://packagist.org/packages/skobkin/magnetico-web)
|
|
|
|
# Magnetico Web PHP
|
|
|
|
Magnetico Web is a simple web search interface for [magneticod](https://github.com/boramalper/magnetico) database.
|
|
|
|
# Installation
|
|
|
|
Application setup is quite simple:
|
|
|
|
## Getting the source code
|
|
|
|
### Using Git
|
|
```bash
|
|
git clone https://skobkin@bitbucket.org/skobkin/magnetico-web.git
|
|
cd magnetico-web
|
|
```
|
|
|
|
### Using Composer
|
|
```bash
|
|
composer create-project skobkin/magnetico-web -s dev
|
|
cd magnetico-web
|
|
```
|
|
|
|
## Setting file access privileges
|
|
Set up appropriate [write permissions](https://symfony.com/doc/current/setup/file_permissions.html) for `var/cache` and `var/logs`.
|
|
|
|
## Installing dependencies (not needed after installation via Composer)
|
|
|
|
```bash
|
|
# In developer environment:
|
|
composer install
|
|
# In production environment
|
|
composer install --no-dev --optimize-autoloader
|
|
```
|
|
|
|
After dependencies installation you may be needed to create `.env.local` file (see `.env` for reference)
|
|
or set appropriate [environment variables](https://en.wikipedia.org/wiki/Environment_variable)
|
|
for production usage.
|
|
|
|
Check [Symfony documentation](https://symfony.com/doc/5.1/configuration.html#overriding-environment-values-via-env-local) for more details about `.env` files.
|
|
|
|
You can also check [this post](https://symfony.com/doc/5.1/configuration/dot-env-changes.html) about `.env` changes in Symfony if you're updating from an
|
|
old version of the project.
|
|
|
|
## Database configuration
|
|
|
|
See [Symfony database configuration](https://symfony.com/doc/current/doctrine.html#configuring-the-database)
|
|
documentation for more details.
|
|
|
|
You **must** set environment variables for both databases: magneticod's and magnetico-web's PostgreSQL.
|
|
|
|
## Database schema migration
|
|
|
|
```bash
|
|
# Only for 'default' EntityManager (Application entities)
|
|
php bin/console doc:mig:mig --em=default
|
|
```
|
|
|
|
## User creation
|
|
|
|
```bash
|
|
# see --help for more info
|
|
# If you don't specify the password it'll be requested from you in the command line
|
|
php bin/console user:add <your_username> <your_email> [your_password] [--invites=10]
|
|
```
|
|
|
|
## Web assets installation
|
|
|
|
```bash
|
|
php bin/console assets:install public --symlink
|
|
```
|