Quickstart
How to get started with Jeasx
It's easy to get started. Just use the following commands to set up and start your first project:
npm create jeasx@latest
cd jeasx-quickstart
npm run build
npm run dev
If you want to create a new project with a specific name, you can provide an additional argument:
npm create jeasx@latest my-awesome-project
If your project is successfully started, just visit http://localhost:3000/ in a browser of your choice.
If you want to see the quickstart example in action, you can visit a deployed version of the quickstart template at https://quickstart.jeasx.dev/. The contents of the quickstart template can be found at GitHub.
Jeasx is developed and tested with the latest LTS version of Node.js (currently Node 22). Node >= v20.12.0 should work, too. Older versions are not supported. Newer Node versions should work without problems, but are not recommended for production.
Jeasx is tested against Bun (>= v1.2.8) and all Jeasx examples powered by Bun are working without any issues, so Bun can be considered as a stable platform for running Jeasx.
If you encounter any issues, feel free to report them.
Install project with Docker support
If you want to use Docker, you can bootstrap a new project with additional resources (Dockerfile
, .dockerignore
) via the following flag:
npm create jeasx@latest -- --with-docker
Install project with Vercel support
If you are going to deploy your project on Vercel, you can bootstrap a project with additional resources (vercel.json
, api/vercel.js
) via the following flag:
npm create jeasx@latest -- --with-vercel