genesis-dashboard

command module
v0.0.0-...-6b8d177 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 7, 2023 License: BSD-3-Clause Imports: 1 Imported by: 0

README


Genesis

Genesis-Dashboard

Make your site dynamic in few clicks!!

Contributors License

About The Project

Genesis-Dashboard - With this powerful tool, users can create their own tables and easily add data to them. The tables are securely saved in the backend, ensuring data integrity and flexibility. What's more, these tables are exposed through public endpoints, enabling seamless integration with other websites and applications

Key Features:

  1. User-friendly Interface: Genesis-Dashboard offers a simple and intuitive interface for easy table management.

  2. Easy to Deploy: Genesis-Dashboard is easy to deploy as the frontend is embedded with the backend and containerized with Docker.

  3. Data Integrity: We ensure data integrity by storing tables in a secure backend.

  4. Public Endpoints: Tables are exposed through public endpoints, enabling seamless integration with other websites and applications.

  5. Easy to Use: Genesis-Dashboard is easy to use.

  6. JWT secured user accounts.

  7. Fast: Genesis-Dashboard is fast as it is built with latest technologies such as Go, React, Postgresql, RoseDB.

Built With

  • Backend: Go + Labstack Echo
  • Frontend: React + Tailwind
  • Containerization and deployment: Docker + Fly.io
  • Embedded Caching: RoseDB

Usage

First go to https://dashboard.genesis.nexentra.online and create your account. Then go to the Tables page. You can create a new table by clicking on the Create A Table button. You can also delete a table by clicking on the Delete button. You can add data to a table by clicking on the Add Data button. You can also edit or delete data by clicking on the Edit or Delete button respectively. Then come back to the homepage and make get request to the given endpoints to get the data.

Getting Started

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

Prerequisites

  • Taskfile
  • Nodejs v16.20.2
  • Go v1.18 or higher

Installation

  1. Clone the repo

    git clone git@github.com:nexentra/genesis-dashboard.git
    
  2. Create a .env file in the root directory and add the environment variables from the .env.example file with your own values. Make sure to set PRODUCTION to false in development.

  3. Run the following command to start the server:

    task run
    
  4. Go to http://localhost:3000 to access the frontend. and http://localhost:8080 to access the backend.

Note

You can find more commands in the taskfile. The taskfile should be self explanatory. In devmode the frontend and backend will run seperately and in production mode the frontend will be embedded with the backend. So in production mode you can access the frontend from the backend port (:8080). And in devmode you can access the frontend from the :3000 port.

License

Distributed under the GPL-3 License. See LICENSE for more information.

Authors

  • Towhid Khan - I am a Software Developer.I enjoy using my skills to contribute to the exciting technological advances that happen every day. - Towhid Khan - Main Developer Behind this project

Acknowledgements

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
api
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL