Skip to content

Commit 6e54f91

Browse files
committed
configured
1 parent 25eb026 commit 6e54f91

File tree

14 files changed

+384
-78
lines changed

14 files changed

+384
-78
lines changed

README.md

Lines changed: 135 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,136 @@
1-
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
1+
# CNC-MySQL Studio
2+
3+
**CNC-MySQL Studio** is an advanced, open-source MySQL management tool developed by Code N Code IT Solutions. Built on Laravel 11.x and React with TypeScript, CNC-MySQL Studio provides a modern, powerful, and user-friendly interface for managing MySQL databases. Inspired by industry tools like PHPMyAdmin and JetBrains DataGrip, it includes AI-driven query suggestions, advanced data visualization, and rich customization options.
4+
5+
---
6+
7+
## Features
8+
9+
### Core Features
10+
- **Database Management**: View, create, update, and delete databases with ease.
11+
- **Table Management**: Efficiently manage tables, including schema updates, data entry, and record management.
12+
- **User Management & Access Control**: Role-based access control with support for Multi-Factor Authentication (MFA).
13+
- **SQL Query Execution**: Full support for executing raw SQL queries, with logging and export options.
14+
- **Data Import & Export**: Seamlessly import/export data in various formats (CSV, JSON, XML).
15+
- **Schema Versioning**: Track schema changes with built-in version control for easy rollbacks.
16+
17+
### Advanced Features
18+
- **AI-Driven Query Suggestions**: Powered by AI, CNC-MySQL Studio suggests optimized query structures and provides auto-complete options to improve productivity and performance.
19+
- **Real-Time Query Analysis**: Analyze query performance in real time, including execution time, query plan, and recommendations for optimization.
20+
- **Visual Data Modeling**: Drag-and-drop interface for designing and visualizing database schema and relationships.
21+
- **Data Visualization Tools**: Generate interactive graphs, charts, and dashboards directly from data tables to visualize patterns and insights.
22+
- **Dark Mode and Custom Themes**: Switch between light and dark modes or customize the theme to suit your preferences.
23+
- **Error Detection & Debugging**: Built-in error detection with suggestions and debugging tools to help you troubleshoot issues instantly.
24+
25+
### Security Features
26+
- **Multi-Factor Authentication (MFA)**: Secure your login with additional authentication layers.
27+
- **Role-Based Access Control (RBAC)**: Set fine-grained permissions for users, ensuring data security and limited access.
28+
- **Activity Logging**: Logs all activity, providing audit trails for changes and access.
29+
30+
### Integrations
31+
- **Support for External Databases**: Connect to external MySQL databases with ease.
32+
- **API Support**: Access and manage databases through a RESTful API for integration with other applications.
33+
34+
---
35+
36+
## Installation
37+
38+
### Requirements
39+
- PHP 8.x
40+
- Node.js 16.x or later
41+
- MySQL 5.7 or later
42+
- Composer
43+
44+
### Steps
45+
46+
1. **Clone the Repository**
47+
```bash
48+
git clone https://github.com/CodeNCode-IT-Solutions/cnc-mysql-studio.git
49+
cd cnc-mysql-studio
50+
2. **Install Backend Dependencies**
51+
```bash
52+
composer install
53+
3. **Install Frontend Dependencies**
54+
```bash
55+
npm install
56+
4. **Configure Environment**
57+
- Duplicate `.env.example` to `.env` and configure your database credentials:
58+
```plaintext
59+
DB_CONNECTION=mysql
60+
DB_HOST=127.0.0.1
61+
DB_PORT=3306
62+
DB_DATABASE=your_database
63+
DB_USERNAME=your_username
64+
DB_PASSWORD=your_password
65+
```
66+
5. **Generate Application Key**
67+
```bash
68+
php artisan key:generate
69+
6. **Run Migrations**
70+
```bash
71+
php artisan migrate
72+
73+
7. **Build and Serve the Application**
74+
- Development Server
75+
```bash
76+
npm run dev
77+
php artisan serve
78+
```
79+
- Production Build
80+
```bash
81+
npm run build
82+
```
83+
84+
8. **Access Application**
85+
- Open your browser and go to [http://localhost:8000/phpmyadmin](http://localhost:8000/phpmyadmin) or [http://localhost:8000](http://localhost:8000), depending on your configuration.
86+
---
87+
88+
## Usage
89+
90+
### SQL Query Suggestions
91+
The AI-driven query suggestion tool automatically provides optimized query recommendations based on your input, ensuring efficiency and performance.
92+
93+
### Data Visualization
94+
Navigate to the **Data Visualization** tab on any table to access interactive charts, graphs, and summaries, which can be customized and exported.
95+
96+
### Advanced Data Modeling
97+
Use the **Schema Designer** to drag-and-drop table relations, visualize the database structure, and track changes.
98+
99+
---
100+
101+
## Development
102+
103+
### Running Tests
104+
Run unit tests for backend and frontend:
105+
- **Backend**: PHPUnit
106+
```bash
107+
php artisan test
108+
109+
- **Frontend**: Jest
110+
```bash
111+
npm run test
112+
113+
### API Documentation
114+
For API integration, CNC-MySQL Studio provides a comprehensive RESTful API. Access API documentation at `/api/docs` after installation.
115+
116+
### Contributing
117+
- Fork the repository
118+
- Create a new branch (`git checkout -b feature`)
119+
- Make your changes
120+
- Commit your changes (`git commit -am 'Add new feature'`)
121+
- Push to the branch (`git push origin feature`)
122+
- Create a new Pull Request
123+
- Follow the Code of Conduct
124+
- Wait for review and approval
125+
- Merge changes
126+
- Celebrate your contribution!
127+
- **Note**: Please update the README with details of changes and new features.
128+
- **Note**: Ensure that your code follows the existing coding standards and conventions.
129+
- **Note**: Write detailed commit messages and PR descriptions for better understanding.
130+
- **Note**: Test your changes thoroughly before submitting a PR.
131+
- **Note**: Document any new features or changes in the README.
132+
- **Note**: Follow the [Contributing Guidelines](CONTRIBUTING.md) for more details.
133+
- **Note**: Respect the [Code of Conduct](CODE_OF_CONDUCT.md) and be respectful to others.
134+
- **Note**: Have fun and enjoy contributing to open-source projects!
135+
- **Note**: If you have any questions or need help, feel free to reach out to the maintainers.
2136

3-
<p align="center">
4-
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
5-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
6-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
7-
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
8-
</p>
9-
10-
## About Laravel
11-
12-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
13-
14-
- [Simple, fast routing engine](https://laravel.com/docs/routing).
15-
- [Powerful dependency injection container](https://laravel.com/docs/container).
16-
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
17-
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
18-
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
19-
- [Robust background job processing](https://laravel.com/docs/queues).
20-
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
21-
22-
Laravel is accessible, powerful, and provides tools required for large, robust applications.
23-
24-
## Learning Laravel
25-
26-
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
27-
28-
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
29-
30-
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
31-
32-
## Laravel Sponsors
33-
34-
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
35-
36-
### Premium Partners
37-
38-
- **[Vehikl](https://vehikl.com/)**
39-
- **[Tighten Co.](https://tighten.co)**
40-
- **[WebReinvent](https://webreinvent.com/)**
41-
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
42-
- **[64 Robots](https://64robots.com)**
43-
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
44-
- **[Cyber-Duck](https://cyber-duck.co.uk)**
45-
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
46-
- **[Jump24](https://jump24.co.uk)**
47-
- **[Redberry](https://redberry.international/laravel/)**
48-
- **[Active Logic](https://activelogic.com)**
49-
- **[byte5](https://byte5.de)**
50-
- **[OP.GG](https://op.gg)**
51-
52-
## Contributing
53-
54-
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
55-
56-
## Code of Conduct
57-
58-
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
59-
60-
## Security Vulnerabilities
61-
62-
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
63-
64-
## License
65-
66-
The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

bootstrap/app.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
return Application::configure(basePath: dirname(__DIR__))
88
->withRouting(
99
web: __DIR__.'/../routes/web.php',
10+
api: __DIR__.'/../routes/api.php',
1011
commands: __DIR__.'/../routes/console.php',
1112
health: '/up',
1213
)

composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
"require": {
88
"php": "^8.2",
99
"laravel/framework": "^11.9",
10+
"laravel/sanctum": "^4.0",
1011
"laravel/tinker": "^2.9"
1112
},
1213
"require-dev": {

composer.lock

Lines changed: 65 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package-lock.json

Lines changed: 47 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)