Getting Started

📌 You can watch a video tutorial on our Youtube Channel.

Create full stack JavaScript applications within seconds using npx to generate your project files from the latest template.

🔥 The minimum required node.js version for development mode is 12.20.0.

Replace project-name with your project name and run the command below to start a project:

npx create-nullstack-app@latest project-name

💡 You can use a CLI to select the blank javascript or typescript template or select the template with tailwind css.

Change directory to the generated folder:

cd project-name

Install the dependencies:

npm install # or yarn

Start the application in development mode:

npm start # or yarn start

Understanding the generated files

The following folders and files will be generated:

server.js

This is the server entry and generator point.

It is a convenient place to set up global things like database and manipulate server context, details in application startup.

client.js

This is the client entry and generator point.

It is a convenient place to import global dependencies like CSS frameworks and manipulate client context.

src/

This folder will contain the actual source code of your application.

src/Application.jsx

This is your application main file.

✨ Learn more about the jsx elements.

When you run npm start it is consumed in server/client JS files by their Nullstack.start function, which starts and returns both context, that you can use to set up things like database using settings and secrets.

✨ Learn more about the application startup.

TypeScript

You can use Nullstack with TypeScript, just rename njs to nts or jsx to tsx.

src/Application.css

This is an empty file just to demonstrate that you can use CSS with Nullstack.

It is a good practice to import a style file in a component with the same name.

✨ Learn more about styles.

public/

Every file in here will be available to anyone from the domain root.

By default create-nullstack-app generates the icons required for your manifest.json and images for OG meta tags.

✨ Learn more about manifest.json.

Be sure to replace these images with your project identity.

.development/

This is the compiled result of your application in development mode.

🔥 Do not touch this folder

.production/

This is the compiled result of your application in production mode.

🔥 Do not touch this folder

✨ Learn more about how to deploy a Nullstack application.