{"id":13623668,"url":"https://github.com/postalserver/docs","last_synced_at":"2025-04-04T22:05:00.193Z","repository":{"id":39706504,"uuid":"390336974","full_name":"postalserver/docs","owner":"postalserver","description":"📚 Documentation for the Postal mail server!","archived":false,"fork":false,"pushed_at":"2025-01-08T13:35:38.000Z","size":6237,"stargazers_count":138,"open_issues_count":10,"forks_count":61,"subscribers_count":9,"default_branch":"main","last_synced_at":"2025-03-28T21:04:17.923Z","etag":null,"topics":["documentation","email","smtp-server"],"latest_commit_sha":null,"homepage":"https://docs.postalserver.io","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/postalserver.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-28T12:04:55.000Z","updated_at":"2025-02-25T22:12:50.000Z","dependencies_parsed_at":"2024-03-03T17:22:40.760Z","dependency_job_id":"fb7144fa-224c-4ad6-8f9b-9485a06d160a","html_url":"https://github.com/postalserver/docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/postalserver%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/postalserver","download_url":"https://codeload.github.com/postalserver/docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247256110,"owners_count":20909240,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","email","smtp-server"],"created_at":"2024-08-01T21:01:34.355Z","updated_at":"2025-04-04T22:05:00.166Z","avatar_url":"https://github.com/postalserver.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# View the Site\n👉 See the live documentation site at https://docs.postalserver.io\n\n# Postal Server Documentation\nPostal is a complete and fully-featured mail server for use by websites and web servers. Think of Sendgrid, Mailgun, or Postmark, but open source and ready for you to run on your own servers. Postal was developed by aTech Media to serve its own mail processing requirements, and we have since decided that it should be released as an open-source project for the community. It was originally launched by us as AppMail but was renamed to Postal as part of making it open source because we felt the name was more suitable.\n\n## The Purpose of This Repository\nThis repository hosts the documentation for Postal only. If you are looking for the GitHub repository for the application source code, [go to the open-source repository for Postal →](https://github.com/postalserver/postal)\n\n## Contribution Instructions\nContributions are welcome! Please open up a pull request that clearly describes your intentions.\n\nThis site runs on [Nuxt Content](https://content.nuxtjs.org/). Please review their documentation to understand how this framework works.\n\n# Local Development Setup\nFollow these steps to get the site running on your local machine.\n\n### Prerequisites\n- Node 18 or newer \n- [PNPM installed](https://pnpm.io/installation) for package management.\n\nWe advise you to use [NVM](https://github.com/nvm-sh/nvm) to manage node versions and enable PNPM using corepack.\n\n\u003cdetails\u003e\n\u003csummary\u003eNVM Setup\u003c/summary\u003e\n\n**Change to the project directory**\n```bash\ncd /path/to/postal-docs\n```\n\n**Install the correct Node version**\n```bash\nnvm install\n```\n\n**Use the correct Node version**\n```bash\nnvm use\n```\n\n\n\u003c/details\u003e\n\n\n\u003cdetails\u003e\n\n\u003csummary\u003eEnable PNPM\u003c/summary\u003e\n\n### Corepack\n\nPNPM is available by default; you just need to enable corepack.\n\n```bash\ncorepack enable pnpm\n```\n\n\u003c/details\u003e\n\n\n\n\n### Prepare Your System\n\n\n**Change to the project directory**\n```bash\ncd /path/to/postal-docs\n```\n### Install Dependencies\nInstall the Node dependencies using PNPM.\n```bash\npnpm install\n```\n### Start the Development Web Server\nStart the development server on http://localhost:3000\n\n\u003e [!NOTE]\n\u003e If you see a warning about a \"Missing `NUXT_UI_PRO_LICENSE`\", you can ignore that message. This is only used in production.\n\n```bash\npnpm dev\n```\n\nYour local development environment is now running. You can view the site at http://localhost:3000. Any changes you make to the content will be automatically reflected in the browser once you save the file.\n\n## How to Edit the Docs Content?\nThis documentation uses [Nuxt Content](https://content.nuxtjs.org/) and works on the following key concepts:\n- Content is stored as markdown files in the `/content` folder.\n- Pages are sorted by the number at the beginning of their MD file. \n- Pages need to have a title and description as their metadata.\n- You can use any Nuxt UI and [Nuxt UI Pro prose component](https://ui.nuxt.com/pro/prose/callout). \n\n\n#### Example:\n```\n---\ntitle: Feature List\ndescription: 'This is a list of features (in no particular order) of things that Postal can do.'\n---\n\n# Feature List\nHere you can write your content. \n...","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostalserver%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpostalserver%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpostalserver%2Fdocs/lists"}