Skip to main content

Documentation

Everything you need to know about using appsgm. Guides, API references, and best practices.

Getting Started Repositories Collaboration API Reference Git Integration Best Practices FAQ

Getting Started

Create Your Account

  1. Visit the registration page
  2. Enter your email and choose a username
  3. Set a strong password
  4. Verify your email address
  5. Complete your profile (optional)

Set Up Git

Configure Git with your appsgm credentials:

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

First Repository

Create your first repository:

# Create a new repository on the command line
echo "# My Project" >> README.md
git init
git add README.md
git commit -m "first commit"
git branch -M main
git remote add origin https://appsgm.example.com/username/repo.git
git push -u origin main

Repositories

Creating Repositories

  • Click "New Repository" from dashboard
  • Choose repository name
  • Add description (optional)
  • Set visibility (public/private)
  • Add README file (recommended)
  • Add .gitignore template
  • Choose license

Repository Settings

  • General settings (rename, transfer)
  • Collaborators and teams
  • Branches and protection rules
  • Webhooks and services
  • Deploy keys
  • Danger zone (delete, archive)

Collaboration

Working with Teams

appsgm supports team-based collaboration:

Invite Members

Add team members by username or email

Set Permissions

Control access levels for team members

Manage Projects

Organize repositories by team

Code Review Process

  1. Create a feature branch
  2. Make changes and commit
  3. Push changes to appsgm
  4. Create a pull request
  5. Request reviews from team members
  6. Address feedback and make changes
  7. Merge after approval

API Reference

Authentication

appsgm API uses OAuth2 for authentication. Get your access token:

curl -X POST https://appsgm.example.com/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "password",
    "username": "your-username",
    "password": "your-password"
  }'

Common Endpoints

Endpoint Method Description
/api/v1/user GET Get authenticated user info
/api/v1/repos GET List user repositories
/api/v1/repos/{owner}/{repo} GET Get repository details
/api/v1/repos/{owner}/{repo}/issues POST Create new issue

Git Integration

Common Git Commands

Command Description
git clone https://appsgm.example.com/user/repo.git Clone a repository
git push origin main Push changes to appsgm
git pull origin main Pull latest changes
git fetch --all Fetch all branches
git merge feature-branch Merge a branch

Best Practices

Repository Structure

  • Use meaningful README files
  • Include proper .gitignore
  • Add LICENSE file
  • Organize code logically
  • Use consistent naming conventions

Commit Messages

  • Use imperative mood
  • Keep subject line under 50 chars
  • Add detailed body when needed
  • Reference issues with #number
  • Be descriptive but concise

Frequently Asked Questions

Go to the login page and click "Forgot Password". Enter your email address and follow the instructions sent to your inbox.

Yes, when creating a repository, you can choose between public and private visibility. You can also change this setting later in repository settings.

Go to your account settings, scroll to the "Danger Zone" section, and click "Delete Account". Note: This action is irreversible.

Individual files are limited to 100MB. For larger files, consider using Git LFS (Large File Storage).

Use the "Report" button on any repository, issue, or comment. You can also email [email protected] with details.