Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (17 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

26 lines (17 loc) · 1.2 KB

Contributing

This repository uses Bun for workspace and dependency management. To get started, run the following commands:

bun install

The repository is structured as follows:

  • api: The API server which is served via https://api.docs.page. This is an express application which handles tasks such as fetching content from GitHub and markdown parsing.
  • og: A Next.js application which serves the Open Graph images for documentation pages.
  • website: A Next.js application which serves the main https://docs.page website, and the documentation rendering for each repository.
  • packages/cli: A CLI for running various commands and scripts for initialization, checking etc. Used locally and on CI environments.

Running docs.page

Generally, you'll want to interface with the website and api. To run these concurrently, you can use the following command:

bun dev

This will start the website on http://localhost:3000 and the api on http://localhost:8080.

The API requires a GITHUB_APP_ID and GITHUB_APP_PRIVATE_KEY to be set in your environment. These are used to authenticate with the GitHub API. You can create a GitHub App in your GitHub account settings.