This script automates the complete setup of Contentful spaces for your app, including app definition creation, space creation, team assignments, and app installations.

1. Creates App Definitions (staging and production) in your Contentful organization
2. Creates Two Spaces: Production and Staging environments
3. Assigns Teams to both spaces with admin privileges
4. Installs the App in both spaces
5. Provides Configuration Links to finish app setup

1. Copy the example environment file:

   cp .env-example .env

2. Fill in your Contentful credentials in .env:

   CONTENTFUL_ACCESS_TOKEN=your_access_token_here
   CONTENTFUL_ORGANIZATION_ID=your_org_id_here
   CONTENTFUL_TEAM_ID=your_team_id_here
   CONTENTFUL_APP_NAME=Your App Name
   CONTENTFUL_ENVIRONMENT=master

1. Go to Contentful Web App
2. Navigate to Settings → API keys → Content management tokens
3. Generate a new personal access token
4. Copy the token to CONTENTFUL_ACCESS_TOKEN in your .env file

1. In Contentful, go to your organization settings
2. The organization ID is in the URL: app.contentful.com/account/organizations/{ORGANIZATION_ID}
3. Copy this ID to CONTENTFUL_ORGANIZATION_ID in your .env file

1. Go to Settings → Teams
2. Click on the team you want to assign
3. The team ID is in the URL: app.contentful.com/account/organizations/{ORG_ID}/teams/{TEAM_ID}
4. Copy this ID to CONTENTFUL_TEAM_ID in your .env file

For testing purposes, the script includes a teardown function that completely removes all created resources.

1. Uncomment the teardown section at the bottom of the file scripts/setup.ts:

   // FOR TESTING - uncomment to undo setup
   await teardown({
     client,
     organizationId,
     spaceIdStaging: stagingSpace.sys.id,
     spaceIdProduction: productionSpace.sys.id,
     appDefinitionIdStaging: appDefinitionStaging.sys.id,
     appDefinitionIdProduction: appDefinitionProduction.sys.id,
   });

2. Run the setup script as normal:

   npm run setup

1. Navigate to the scripts directory:

   cd scripts

2. Install dependencies:

   npm install

3. Configure your .env file (see Configuration section above)

4. Run the setup script:

   npm run setup

• Staging: {appName} (staging)
• Production: {appName} (production)
• Location: Your Contentful organization
• Status: Created but needs configuration

• Production: {appName} (production)
• Staging: {appName} (staging)
• Team Access: Admin privileges for all members in specified team
• App Installation: Your app installed in both spaces

After running the script successfully:

1. Configure your app definitions using the provided links
2. Set up app locations (entry field, page, etc.)
3. Configure app parameters if needed