Website generation with Couscous

This commit is contained in:
Milos Stojanovic
2019-06-18 16:07:37 +02:00
parent f5e2553396
commit 917863b208
4 changed files with 20 additions and 8 deletions

View File

@@ -101,7 +101,8 @@
<section class="col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10">
<h2 id="project-setup-for-development">Project setup for development</h2>
<h2 id="project-setup-for-development-linux">Project setup for development (Linux)</h2>
<p>You must have <code>git</code>, <code>php</code>, <code>npm</code>, and <code>composer</code> installed.</p>
<pre><code>git clone git@github.com:filegator/filegator.git
cd filegator
cp configuration_sample.php configuration.php
@@ -110,14 +111,15 @@ sudo chmod -R 777 repository/
composer install
npm install
npm run build</code></pre>
<h2 id="compiles-and-hot-reloads-backend-and-frontend-on-ports-8081-and-8080">Compiles and hot-reloads (backend and frontend on ports 8081 and 8080)</h2>
<h2 id="compiles-and-hot-reloads">Compiles and hot-reloads</h2>
<p>The following command will launch backend and frontend on ports 8081 and 8080:</p>
<pre><code>npm run serve</code></pre>
<p>Once everything is ready visit: <code>http://localhost:8080</code></p>
<h2 id="run-tests-amp-static-analysis">Run tests &amp; static analysis</h2>
<pre><code>vendor/bin/phpunit
vendor/bin/phpstan analyse ./backend</code></pre>
<h2 id="deployment">Deployment</h2>
<p>Set the website document root to <code>/dist</code> directory.</p>
<p>Set the website document root to <code>/dist</code> directory. This is also known as 'public' folder.</p>
</section>
</div>