OnePanel

A plug and play Admin Panel for your applications. Designed for developers.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • System Architecture
2. Getting Started
   • Prerequisites
   • Installation
3. Screenshots
4. Usage - Demo Video

About The Project

OnePanel provides easy to use solutions for adding an Admin Panel to any development project. Data is stored in MongoDB Databases and the connection URIs for each are accessible. The data is made accessible to the developer by exposing API endpoints.

The main problem that developers face is managing data from non-technical clients who lack knowledge of data structures and database management. This leads to difficulties in gathering and structuring the required data for projects. The motivation behind this project is to streamline the data management process and provide a user-friendly solution to simplify data integration for both developers and non-technical stakeholders. By creating an 'Admin Panel as a Service,' the project aims to enhance the productivity and effectiveness of developers and businesses alike. The primary objectives of the project are as follows:

• Develop an admin panel as a service with a simple graphical user interface for non-technical users to add and manage data efficiently.

• Provide developers with the ability to define customizable data structures and schema for their projects.

• Implement secure data handling and access control mechanisms within the admin panel.

• Expose API endpoints to enable developers to use the data with their preferred architecture plans.

• To Do Integrate a generative AI module to generate mock data, facilitating realistic visualization of projects during the approval phase.

(back to top)

Built With

The following technologies contributed signifactly to the development of this project

• NodeJS
• Typescript
• ReactJs
• TailwindCSS
• golang
• MongoDB

(back to top)

System Architecture

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

You will need to have the following dependencies installed on your system

• Golang click here
• NodeJs click here
• Access to a remote or local mongodb instance (connection URI)

Screenshots

Auth Page

Databases

Creating new Databases

Search through Databases

Single Database view -> Artifacts page

Panel/New Entry form

Current entries

Schema

Installation

Below is a rough step by step guide on how to get the project up and running

1. Clone the repo

   git clone https://github.com/marsian83/one-panel

2. Install NPM packages for client

   cd client
   
   yarn

3. Install NPM packages for server

   cd server
   
   yarn

4. Install go modules for the following services

   /api
   /services/db_access
   /services/mockdata
   

5. Run the client

   cd client
   yarn dev

6. Run the server similarly and run the aforementioned Go services

(back to top)

Usage

onepanel.mp4

(back to top)