diff --git a/.env.dist b/.env.dist index e68da16..f847f27 100644 --- a/.env.dist +++ b/.env.dist @@ -4,7 +4,7 @@ ###> symfony/framework-bundle ### APP_ENV=dev -APP_SECRET=910447ac07f8ff2c6f0defe413c42062 +APP_SECRET=xxx #TRUSTED_PROXIES=127.0.0.1,127.0.0.2 #TRUSTED_HOSTS=localhost,example.com ###< symfony/framework-bundle ### @@ -13,5 +13,5 @@ APP_SECRET=910447ac07f8ff2c6f0defe413c42062 # Format described at http://docs.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/configuration.html#connecting-using-a-url # For an SQLite database, use: "sqlite:///%kernel.project_dir%/var/data.db" # Configure your db driver and server_version in config/packages/doctrine.yaml -DATABASE_URL=sqlite:///home/skobkin/.local/share/magneticod/database.sqlite3 +DATABASE_URL=sqlite:////home/magnetico/.local/share/magneticod/database.sqlite3 ###< doctrine/doctrine-bundle ### diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b580831 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) 2018 Alexey Skobkin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6e63ec7 --- /dev/null +++ b/README.md @@ -0,0 +1,52 @@ +[![Codeship Status for skobkin/magnetico-web](https://app.codeship.com/projects/9da4d3e0-57cf-0136-9885-5644a850740d/status?branch=master)](https://app.codeship.com/projects/295041) +[![Total Downloads](https://poser.pugx.org/skobkin/magnetico-web/downloads)](https://packagist.org/packages/skobkin/magnetico-web) +[![License](https://poser.pugx.org/skobkin/magnetico-web/license)](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` file (see `.env.dist`) +or set appropriate [environment variables](https://en.wikipedia.org/wiki/Environment_variable) +for production usage. + +## Database configuration + +See [Symfony database configuration](https://symfony.com/doc/current/doctrine.html#configuring-the-database) +documentation for more details. + +## Web assets installation + +```bash +php app/console assets:install public --symlink +``` diff --git a/composer.json b/composer.json index 307cb1e..3d6c4d5 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,16 @@ { + "name": "skobkin/magnetico-web", + "description": "Simple web search interface for magneticod database", + "license": "MIT", + "authors": [ + { + "name": "Alexey Skobkin", + "email": "skobkin-ru@ya.ru", + "homepage": "https://skobk.in/", + "role": "founder" + } + ], "type": "project", - "license": "proprietary", "require": { "php": "^7.2.0", "ext-ctype": "*",