Installation
Setup
Note: You could use the ready-to-use (pre-compiled) demos available
in the dist folder, if you are not looking for any
customization. In that case, you can skip below setup steps.
We are using gulp which allows to have complete automatation for build flow. In case if you don't know - Gulp is a toolkit for automating painful or time-consuming tasks in development workflow, so you can stop messing around and build something. You can read it more about it here. Please follow below steps to install and setup all prerequisites:
Prerequisites
Please follow below steps to install and setup all prerequisites:
-
Node.js
In order to use build tools you will need to download and install Node.js. If you do not have Node.js installed already, you can get it by downloading the package installer from the official website. Please download the stable version of Node.js (LTS).
Download Node.js -
Gulp & Gulp CLI
Make sure to have the Gulp installed & running in your computer. If you already have installed gulp on your computer, you can skip this step. In order to install, just run command
npm install -g gulp@4.0.1from your terminal. -
Yarn
Make sure to have the Yarn installed & running in your computer. If you already have installed yarn on your computer, you can skip this step.
-
Git
Make sure to have the Git installed & running in your computer. If you already have installed git on your computer, you can skip this step
-
Sqlite3 (For Windows)
Open the download page https://www.sqlite.org/download.html and download command-line tools file for your operating system.
-
PHP 7.4
Make sure to have PHP-7.4 or latest version installed & running on your computer. If you already have installed PHP on your computer, you can skip this step.
-
Composer
Make sure to have the Composer installed & running on your computer. If you already have installed Composer on your computer, you can skip this step.
-
Xampp (For Windows)
Make sure to have the latest version of xampp or installed & running on your computer. If you already have installed Xampp on your computer, you can skip this step.
Installation
Open your terminal, go to your folder and enter the command yarn
install. This would install all required dependencies in
node_modules folder. And now, you are ready to run the Attex
for the first time.
You can run the following commands to run project locally or build for production use:
| Command | Description |
|---|---|
yarn |
It will fetch all dependencies as package.json required javascript, sass, etc. The development server is accessible at |
gulp |
Runs demo locally, starts the development server and watches for any changes in your code, including your html, javascript, sass, etc. The development server is accessible at http://localhost:3000/. |
gulp build |
It compiles the source assets including scss and bundles into production ready use. |
composer install |
It will install all dependencies in vendor folder. |
php spark migrate |
It will migrate all the migrations to the database. |
php spark db:seed UserSeeder |
It will fill your database with data after it's created. |
php spark serve |
It will start the development server. |