Lack of Javascript examples

[mryellow]

Documentation Issue

Documentation examples are all TypeScript. These require extra dependencies and build tools along with non-standard syntax.

Additional Details

An example should be provided which uses pure ordinary standard Javascript.

No tsc should be required.

[mryellow]

src/payload.config.js

const fspath = require('path');

//const payloadCloud = require('@payloadcms/plugin-cloud').payloadCloud;
const mongooseAdapter = require('@payloadcms/db-mongodb').mongooseAdapter;
const webpackBundler = require('@payloadcms/bundler-webpack').webpackBundler;
const slateEditor = require('@payloadcms/richtext-slate').slateEditor;
const buildConfig = require('payload/config').buildConfig;

const Users = require('./collections/Users');
const Posts = require('./collections/Posts');

module.exports = buildConfig({
	admin: {
		user: Users.slug,
		bundler: webpackBundler(),
		components: {},
	},
	editor: slateEditor({}),
	collections: [Users, Posts],
	//typescript: {
	//	outputFile: fspath.resolve('payload-types.ts'),
	//},
	graphQL: {
		disable: true, // NOTE: Running with "NODE_ENV=production" causes issues when not using TypeScript
		disablePlaygroundInProduction: true,
		schemaOutputFile: fspath.resolve('generated-schema.graphql'),
	},
	//plugins: [payloadCloud()],
	plugins: [],
	db: mongooseAdapter({
		url: process.env.DATABASE_URI,
	}),
});

src/server.js

const express = require('express');
const payload = require('payload');

require('dotenv').config();
const app = express()

app.get('/', (_, res) => {
	res.redirect('/admin')
});

const start = () => {
	return Promise.resolve()
		.then(() => payload.init({
			debug: true,
			telemetry: false,
			secret: process.env.PAYLOAD_SECRET,
			express: app,
			onInit: () => {
				payload.logger.info(`Payload Admin URL: ${payload.getAdminURL()}`);
			},
		}))
		.then(() => {
			console.log('Starting server!', process.env.PAYLOAD_PORT || 3000);
			app.listen(process.env.PAYLOAD_PORT || 3000);
		});
};

start();

copyfiles -u 1 "src/**/*.js" dist/

cross-env PAYLOAD_CONFIG_PATH=dist/payload.config.js NODE_ENV=foo node dist/server.js

[mryellow]

cross-env PAYLOAD_CONFIG_PATH=src/payload.config.js payload build is not required and causes WASM errors on some systems regardless.

[denolfe]

Hey @mryellow , we've found that the vast majority of our users are using TypeScript, so the documentation is written with that in mind.

While you can still use Payload with vanilla JS, maintaining documentation and examples of this is something we've decided not to do at this point in time.

[mryellow]

our users are using TypeScript

The only reason for that is that you've failed to document how Javascript users can get the system working.

It's a Survivorship Bias you are seeing as a result of your Selection Bias.

I'm not using TypeScript and made the effort to demonstrate how it can be done.

I didn't require any of the extra build tools in order to get the project working.

No JSX was required. No TypeScript was required.

[github-actions]

This issue has been automatically locked.
Please open a new issue if this issue persists with any additional detail.