DSGNR

Version: 0.0.12-dev
Build Name: Harvard Panther
Status: unsafe for production

Keep in mind: This is a development version, which mean it is not safe to use on a production environnement.

However, if you still want to install it in local to check it out and have a little fun modifying the code, you can by following the basic setup process below.

Dependencies

The list of dependencies required to run DSGNR(Harvard Panther) on your system

• PHP 7.1.3+
• Composer 1.7.2+
• NodeJS 9.3.0+
• npm 6.5.0+ or yarn 1.12.3+ (recommended)

Basic setup

• Install laravel dependencies cd api && composer install
• Create the laravel .env file cp .env.example .env && cd ../
• You will need to Setup your environment file
• Install npm dependencies yarn install
• Launch the local server yarn run serve or yarn serve

API Environment

In the directory /api you will find a file .env.example. It is recommended to copy this file and to rename it .env inside you can change the APP_URL or the APP_NAME if you want/need to. For now we use a SQLite database, if you want to use anything else like MySQL, PostgreSQL or Redis, you can change the DB..._ section values. Keep in mind that everything is optimised and made to work with SQLite. Further updates will eventually fix any bug you will encounter while trying unsupported databases.

By default, APP_KEY is not defined, you will need to generate it using the command php artisan key:generate in the /api directory (otherwise artisan will not work).

For the development release it is highly recommended to grant all permissions to the storage folder with a sudo chmod -R 777 api/storage

License

The DSGNR Project is open-sourced software licensed under the MIT license.