ae7d6f97d2
* chore: lint packages/payload * chore: lint packages/db-postgres * chore: lint packages/db-mongodb * chore: update eslintrc exclusion rules * chore: update eslintrc exclusion rules * chore: lint misc files * chore: run prettier through packages * chore: run eslint on payload again * chore: prettier misc files * chore: prettier docs
52 lines
3.2 KiB
Plaintext
52 lines
3.2 KiB
Plaintext
---
|
|
title: Getting Started
|
|
label: Getting Started
|
|
order: 10
|
|
desc: Get started with Payload Cloud, a deployment solution specifically designed for Node + MongoDB applications.
|
|
keywords: cloud, hosted, database, storage, email, deployment, serverless, node, mongodb, s3, aws, cloudflare, atlas, resend, payload, cms
|
|
---
|
|
|
|
A deployment solution specifically designed for Node.js + MongoDB applications, offering seamless deployment of your entire stack in one place. You can get started in minutes with a one-click template or bring your own codebase with you.
|
|
|
|
Payload Cloud offers various plans tailored to meet your specific needs, including a MongoDB Atlas database, S3 file storage, and email delivery powered by [Resend](https://resend.com). To see a full breakdown of features and plans, see our [Cloud Pricing page](https://payloadcms.com/cloud-pricing).
|
|
|
|
To get started, you first need to create an account. Head over to [the login screen](https://payloadcms.com/login) and **Register for Free**.
|
|
|
|
<Banner type="success">
|
|
To create your first project, you can either select [a template](#starting-from-a-template) or
|
|
[import an existing project](#importing-from-an-existing-codebase) from GitHub.
|
|
</Banner>
|
|
|
|
## Starting from a Template
|
|
|
|
Templates come preconfigured and provide a one-click solution to quickly deploy a new application.
|
|
|
|
|
|
_Creating a new project from a template._
|
|
|
|
After creating an account, select your desired template from the Projects page. At this point, you need to connect to authorize the Payload Cloud application with your GitHub account. Click Continue with GitHub and follow the prompts to authorize the app.
|
|
|
|
Next, select your `GitHub Scope`. If you belong to multiple organizations, they will show up here. If you do not see the organization you are looking for, you may need to adjust your GitHub app permissions.
|
|
|
|
After selecting your scope, create a unique `repository name` and select whether you want your repository to be public or private on GitHub.
|
|
|
|
<Banner type="warning">
|
|
<strong>Note:</strong> Public repositories can be accessed by anyone online, while private
|
|
repositories grant access only to you and anyone you explicitly authorize.
|
|
</Banner>
|
|
|
|
Once you are ready, click **Create Project**. This will clone the selected template to a new repository in your GitHub account, and take you to the configuration page to set up your project for deployment.
|
|
|
|
## Importing from an Existing Codebase
|
|
|
|
Payload Cloud works for any Node.js + MongoDB app. From the New Project page, select **import an existing Git codebase**. Choose the organization and select the repository you want to import. From here, you will be taken to the configuration page to set up your project for deployment.
|
|
|
|
|
|
_Creating a new project from an existing repository._
|
|
|
|
<Banner type="warning">
|
|
<strong>Note:</strong> In order to make use of the features of Payload Cloud in your own codebase,
|
|
you will need to add the [Cloud Plugin](https://github.com/payloadcms/plugin-cloud) to your
|
|
Payload app.
|
|
</Banner>
|