alfiephillips / hydralite

Meet the new open-source platform to seamlessly market and manage your product.

Home Page:https://hydralite.io

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Welcome to Hydralite

SemVer - API Version LOC Top Language Repo Size

What Is Hydralite?

Hydralite is an open-source, next-generation project marketing and management platform that uses a platform-specific "currency" called Hydra, which enables you to build a vast community around your product using an algorithmic, promotional feed of content, as well as to conduct your software effectively with an intuitive, one-of-a-kind product management framework.

Project Components

  • web - frontend Next.js web app
  • api - GraphQL API/backend
  • cli - CLI
  • hydrabot - Hydralite Discord Bot
  • landing - Landing Page
  • mobile - Flutter mobile app
  • cz-commitlint-config - custom types based on @commitlint/config-conventional NPM package and our custom Commitizen adapter based on cz-conventional-changelog
  • repo:prototypes - Prototypes

Quick Start for Development

Although we highly recommend reading the contributing guidelines/docs, read on on how to get started contributing to HydraLite.

Make sure you've installed Node.js (Web, API, landing, Discord bot), Python (automation), Rust (CLI) and/or Flutter + Dart (Mobile App) before start hacking/contributing within your local machine, especially if you use code-server in an PaaS where Dockerfiles are supported.

To start both the frontend webapp and the GraphQL API backend servers:

  1. Navigate to the root directory and install dependencies with yarn (or yarn install)
  2. Then, run an intuitive setup procedure with yarn setup. It'll ask you what you need to enter below in order to generate an .env file. You can also create that file manually from .env.example in the API directory and edit manually if you want.
    • OAuth client IDs and secrets for: GitHub, Discord and Google (you can skip if you don't have these, but this might fire up some errors when you start it)
    • Postgres database URL string for data storage and Prisma database migrations.
    • Redis URL for data cache. Although you can use Redis as full-blown database replacement to Postgres, it is currently not supported.
  3. Once setup is complete, run yarn dev to start both the web app and API server in development mode.

Other Ways To Get Started:

Sponsors

YoMo.run

About

Meet the new open-source platform to seamlessly market and manage your product.

https://hydralite.io

License:Apache License 2.0


Languages

Language:TypeScript 81.2%Language:JavaScript 5.0%Language:CSS 3.9%Language:Dockerfile 3.8%Language:Dart 2.9%Language:Rust 1.5%Language:Shell 1.3%Language:Swift 0.1%Language:Python 0.1%Language:Kotlin 0.0%Language:Objective-C 0.0%