Skip to content

Latest commit

 

History

History
146 lines (100 loc) · 6.47 KB

README.md

File metadata and controls

146 lines (100 loc) · 6.47 KB

LUXCIUM MONOREPO ONE

† Scientia est lux principium✨ ™

This monorepo contains various projects, libraries, and services organized in a modular structure. It uses Git submodules and follows the Rush stack monorepo workflow.

Repository Structure

Core Components

LIBRARY

SERVICES

APIs

  • APIs - API implementations and integrations

BACKEND & FRONTEND

  • Backend - Backend services and server-side code
    • API - Core API implementations
    • Scratch - Development and experimental code
  • Frontend - Frontend applications and client-side code
    • Client - Core client applications
    • Home - Home page components
    • Projects - Individual frontend projects

PROMPTS

  • Prompts - Prompts for exercises and examples

PRIVATE

  • Private - Private and confidential files

STATIC

  • Static - Static assets and resources

EXAMPLES

  • Examples - Code examples and demonstrations
    • Template - Template examples for quick starting new modules
    • Open AI - Examples related to OpenAI API usage
    • GPU Stuff - GPU computation examples
    • Node.js - Node.js implementation examples
    • TypeScript - TypeScript implementation examples

SCRIPTS

  • Scripts - Utility and automation scripts

Development Resources

COMMON & SCRIPTS

DOCUMENTATION

  • Monorepo Structure: Documentation of the folder structure and metadata.
  • Naming Conventions: Guide to the agreed-upon naming conventions for files, folders, and variables.
  • Common - Shared configurations and utilities
    • Config - Shared configuration files
    • Git Hooks - Repository management hooks
    • Scripts - Shared utility scripts
  • Scripts - Utility and automation scripts
    • Docker Maintenance
    • Rush Scripts (Note: The links to README.md files are placeholders and will need to be verified for correctness. Each subdirectory should contain a README.md that provides further details about its contents.)

Additional Resources

Getting Started

  1. Clone the repository with submodules:

    git clone --recursive https://github.com/LuxciumProject/monorepo-one.git

  2. Install dependencies using Rush:

    node common/scripts/install-run-rush.js install

  3. Build all projects:

    node common/scripts/install-run-rush.js build

License

Luxcium License: NO PERMISSIONS GRANTED - PROVIDED "AS IS" - WITHOUT WARRANTY

  • THESE FILES ARE NOT FIT FOR ANY PARTICULAR PURPOSE IN THEIR CURRENT FORM.
  • THESE FILES OR THEIR CONTENT HAVE NOT BEEN TESTED OR RUN YET IN ANY OR ALL ENVIRONMENTS!
  • DO NOT RUN ANY OF THESE FILES UNLESS YOU HAVE REVIEWED THEIR FULL CONTENT.
  • YOU MUST TAKE FULL RESPONSIBILITY FOR ANY PROBLEMS THEY MAY CAUSE TO YOU (or anyone).
  • YOU MUST TAKE FULL RESPONSIBILITY FOR ANY PROBLEMS THEY MAY CAUSE TO YOUR MACHINE (or any machine).

NO PERMISSIONS ARE GRANTED FOR THIS SOFTWARE OR DOCUMENTATION

1) NOT TO PUBLISH;
2) NOT TO DISTRIBUTE;
3) NOT TO SUBLICENSE;
4) NOT TO SELL COPIES OF;

Even for unpermited usage you must provide the name of the copyright holder and this must be included in all copies or substantial portions of the Software:

The Software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders X be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the Software.

Except as contained in this notice, the name of the <copyright holders> shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the <copyright holders>. »

COPYRIGHT

Copyright © 2023-2025 · LUXCIUM · (Benjamin Vincent) · luxcium﹫neb401.com

† Scientia est lux principium✨ ™