Signed-off-by: Dušan Mitrović <email@example.com>
|4 months ago|
|public||7 months ago|
|src||7 months ago|
|tests||7 months ago|
|.env.example||11 months ago|
|.gitignore||7 months ago|
|LICENSE||1 year ago|
|README.md||7 months ago|
|composer.json||7 months ago|
|composer.lock||7 months ago|
|key_gen||4 months ago|
|phinx.php||7 months ago|
|phpunit.xml||7 months ago|
Dependencies are tracked through composer, to install them run:
To generate encryption and signature keys, run the commands below:
chmod +x key_gen ./key_gen
Provided you’ve filled in the neccessary information in the .env file (an example is found in .env.example) run the following command:
If you wish to seed the database with random data for testing purposes run the following command:
./vendor/bin/phinx seed:run -s UserSeeder -s JournalSeeder -s ImageSeeder
Logging functionality is handled using the MongoDB database server. A local or MongoDB Atlas instance is required for normal operation. Supply the connection string in the .env file.
Configure your favourite web server to point to the index.php file found in the public directory, a .htaccess file is provided for the Apache Web Server. If you wish to run the built in php development server for testing purposes run:
php -S <IP_ADDRESS>:<TCP_PORT> -t public/
To run unit tests, run the following command:
Journal API is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or any later version.
Journal API is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with Journal API. If not, see https://opensource.org/licenses/GPL-3.0.