Contents

GhostCore Documentation

Getting Started

GhostCore is a platform that unites your services under one ecosystem. Here's how to get started:

1. Create an Account

Start by creating an account and setting up your organization:

  • Click the "Sign Up" button in the navigation bar
  • Fill in your details and organization information
  • Your organization name will be used in URLs (e.g., ghostcore.com/your-org)

2. Add Your First Service

Once logged in, you can start adding services:

  • Navigate to your organization dashboard
  • Click "Add Service"
  • Provide service details including GitHub URL

Organizations

Organizations are the core unit of GhostCore. Each organization can:

  • Host multiple services
  • Have multiple team members
  • Customize their display name and URL
  • Track service analytics
Organization names must be unique and can only contain letters, numbers, and hyphens.

Services

Services represent your GitHub projects. Each service includes:

  • GitHub repository integration
  • README display
  • Version history tracking
  • View and star analytics

Service Features

Feature Description
GitHub Integration Automatic README sync and repository information
Version History Track and display service updates
Analytics Track views and stars for your service

API Reference

GhostCore provides a RESTful API for integrating with your services:

Authentication

curl -X POST https://ghostcore.vercel.app/auth
-H "Content-Type: application/json"
-d '{"username": "your_username", "password": "your_password"}'

Endpoints

Endpoint Method Description
/api/services GET List all services
/api/services/{id} GET Get service details
/api/organizations GET List all organizations

Contributing

We welcome contributions to GhostCore! Here's how you can help:

Development Setup

git clone https://github.com/The-UnknownHacker/ghostcore
cd ghostcore
pip install -r requirements.txt
python app.py

Guidelines

  • Fork the repository
  • Create a feature branch
  • Write clear commit messages
  • Add tests for new features
  • Submit a pull request