### Setup

We are using gulp which allows to have complete automatation for build flow. In case if you don't know - Gulp is a 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:

- Nodejs

  Make sure to have the Node.js installed & running in your computer. If you already have installed nodejs on your computer, you can skip this step

- Gulp

  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.

- 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

##### Installation

To setup Uplon, follow below mentioned steps:

- Install Prerequisites

  Make sure to have all above prerequisites installed & running in your computer

- Install Dependencies

  Open your terminal, go to your folder and enter the command `yarn install`. This would install all required dependencies in `node_modules` folder.

After you finished with above steps, you can run the following commands to run project locally or build for production use:

Command | Description
--- | ---
`gulp` | It will compiles source files and monitor changes to your demo code, including HTML, JavaScript, and Sass.
`gulp build` | The gulp build command compiles the source code for the selected demo and bundles it with production mode optimization for the best performance. This command is typically used when you are ready to build and deploy your project for production use.

- If you are using windows, put your project file in xampp/htdocs/..

- Start the apache server from xampp control pannel if you are using windows.

- Project can be accessed from `localhost/project_name/any_demo/src/index.php`

- You can execute create, insert, update, and delete queries in database using `database.db` file in services folder.

##### Troubleshooting

If you encounter any issues or have any questions during the setup process, please don't hesitate to reach out to us via email. We are always here to help and would be glad to assist you in any way we can.