SIMAS Framework

A PHP-based MVC framework designed to streamline web development and ensure architectural consistency


Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

This project provides a solid foundation for building scalable applications by implementing core backend mechanics from the ground up.

Key Objectives:

• Efficiency: Developed to optimize web development processes and maintain consistent code standards.
• Maintainability: Built with a Native PHP core to ensure long-term stability and deep architectural control.
• Scalability: Designed as a foundational structure to support modular development for various web-based solutions.

DISCLAIMER This project was developed as a technical research project to explore software architecture. It contains only structural framework code and architectural patterns; no proprietary business logic or confidential data from any third party is included.

(back to top)

Getting Started

Follow these steps to set up the project locally.

Prerequisites

• php 8.1 or newer
• composer install it manually from the composer official website

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

1. Clone the repo

   git clone https://github.com/tsaqif06/SIMASFramework.git

2. Install composer packages

   composer install

3. Generate .env file

   cp .env.example .env

4. You’ll need to modify the following block of settings to match your website configuration:

   APP_NAME=SIMASFramework
   APP_DEBUG=true
   DB_DRIVER=mysql
   DB_HOST=localhost
   DB_PORT=3306
   DB_NAME=
   DB_USER=root
   DB_PASS=
   JWT_KEY=
   APP_LANG=en

5. You need to migrate the database located in the database folder by visiting the /runmigrate path in the URL. But if you're ready to publish the website, you can remove the /runmigrate route in routes/route.php

6. In this file, there is already a demonstration of using the SIMAS Framework. Please go to the path /register and fill in the data, which will then be directed to /login. After that, log in, and you will be directed to /user, where there is an example of using CRUD in this framework

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Project Link: https://github.com/tsaqif06/SIMASFramework

(back to top)