Skip to content

kazuyamarino/nsy-docs

Repository files navigation

NSY PHP Framework


About

NSY is a simple PHP Framework that works well on MVC or HMVC mode.

Site example : https://nsyframework.com/.

Codename

Talindo. The traditional West Sulawesi musical instrument Talindo is made from basic materials such as wood, coconut shells and strings. The way to play the Talindo musical instrument is by plucking the strings, then the function of the coconut shell is as a resonance hole. This traditional musical instrument is very popular in the community because it is always present or appears when the harvest season arrives. Not only in West Sulawesi, Talindo is also in Central Sulawesi but has a different name, namely Popondi.

Wadaya, https://www.wadaya.rey1024.com/budaya/detail/talindo-tolindo.


How to dating with NSY?

The Requirement

Before installing NSY, there are several applications that must be installed to support NSY operation.

1. Install Wget

Windows Installation :

  • Download Wget from this site https://eternallybored.org/misc/wget/.
  • Copy the wget.exe file into your C:\Windows\System32 folder. Simply copy it from one location to the other.
  • Verify the Installation on Windows, open the command prompt (cmd.exe) and run wget -V to see if it is installed.

Linux Installation (Debian based) :

  • To install Wget on Linux Ubuntu/Debian use the apt-get command apt-get install wget.
  • And verify installation with the wget command with the wget --version flag.

MacOS Installation :

  • Install Homebrew, In Terminal type the following command:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • Install Wget, In Terminal Type the following command: brew install wget.
  • Check if Wget is installed open Terminal and type wget -V.

2. Install Composer

Windows Installation :

Linux Installation (Debian based) :

  • Download the installer and composer setup:
sudo php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');".
  • Run the installer:
sudo php composer-setup.php --install-dir=/usr/bin --filename=composer
  • Verify the Installation, open Terminal and run composer -V to see if it is installed.

MacOS Installation :

  • Download and install Composer using the following commands:
curl -sS https://getcomposer.org/installer -o composer-setup.php
HASH="$(curl -sS https://composer.github.io/installer.sig)"
php -r "if (hash_file('sha384', 'composer-setup.php') === '$HASH') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
  • If the installer is verified, proceed with the installation:
sudo php composer-setup.php --install-dir=/usr/local/bin --filename=composer.
  • Remove the installer script: rm composer-setup.php.
  • Check that Composer is installed and accessible: composer.

3. Install Git

Windows Installation :

  • Go to the official Git website at https://git-scm.com/.
  • Click on the Download button to get the latest version of Git for Windows.

Linux Installation (Debian based) :

  • Install Git using the package manager: sudo apt install git
  • Check the installed Git version: git --version

MacOS Installation :

  • Install Homebrew, In Terminal type the following command:
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • Once Homebrew is installed, use it to install Git: brew install git

  • Check the installed Git version: git --version


NSY Installation

Download from Github

For apache, please go to the docs/apache folder and read the Readme.txt.

// docs/apache/Readme.txt

1. Copy .htaccess inside 'for_public' folder to 'public' folder
2. Copy .htaccess inside 'for_root' folder to 'root(nsy)' folder

For nginx, please go to the docs/nginx folder and read the Readme.txt too.

// docs/nginx/Readme.txt

1. Open 'sudo nano /etc/nginx/sites-enabled/default'
2. Copy the text in the 'default' file and paste it to /etc/nginx/sites-enabled/default
3. And restart nginx service, 'sudo service nginx restart'
  • Go to the docs/env.example.php folder and copy the env.example.php to root folder, and rename it to env.php.
  • And save the date.

Download from Composer

1. Install NSY by creating a new directory called blog.

composer create-project --prefer-dist vikry/nsy blog

2. Restart Bash.

source ~/reloader.sh

3. NSY Setup.

cd blog && nsy --setup

Enter directory name >
blog

4. NSY is ready to create project.


CRUD Example?

Here it is Vylma CRUD Example And Shyffon CRUD Example.


Overview

See OVERVIEW.


Features


NSY Helper Function

Standar Helper Function


External Helper Function


NSY Middleware

NSY has support middleware, which is the process of filtering a process before it is run by the controller by NSY, See Documentation.


NSY Migration

Migration is like version control for your database, allowing your team to easily modify and share application database schemes, See Documentation.


Razr Template Engine

Razr is a powerful PHP template engine for PHP, whose syntax was inspired by ASP.NET Razor.

NSY has supported Razr in the View component. In addition NSY also still supports PHP code in the View component. Either using Razr or PHP, they can run together in one View component, See Documentation.


NSY Security Function

NSY provides security functions including antiXSS and CSRF, See Documentation.


NSY Controller

Controllers act as an interface between Model and View components to process all the business logic and incoming requests, manipulate data using the Model component and interact with the Views to render the final output, See Documentation.


NSY Model

The Model component corresponds to all the data-related logic that the user works with. This can represent either the data that is being transferred between the View and Controller components or any other business logic-related data, See Documentation.


License

The code is available under the MIT license.

NSY Framework 2019 - 2023.

About

NSY PHP Framework Documentation

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published