The easiest way to create a Burdy application.
- Getting Started — How to create an app
- User Guide — How to develop apps started with Create Burdy App
npm install -g create-burdy-app
create-burdy-app my-app
cd my-app/
npm run devOpen http://localhost:4000 to view your running app.
When you're ready for production, run npm run build then npm run start.
You don't need to install or setup Webpack or Babel.
They come packaged with burdy, so you can just start coding.
After running create-burdy-app, you're good to go!
Install it once globally:
npm install -g create-burdy-appTo create a new app, run:
create-burdy-app my-app
cd my-app
It will create a directory called my-app inside the current folder.
Inside that directory, it will generate the initial project structure and install necessary dependencies:
.
├── node_modules
├── project
│ ├── admin
│ ├── index.tsx
│ ├── types
│ ├── types.d.ts
│ ├── index.ts
├── docker-compose.yml
├── Dockerfile
├── package.json
├── tsconfig.json
└── [...]
Entry points in Burdy are based on the two files:
project/admin/index.tsx(Admin) is used for adding functionality on UI (React) side of the application.project/index.ts(Server) index.ts is used for adding functionality to server side of application.
Out of the box, we get:
- Automatic transpilation and bundling (with webpack and babel)
- Hot code reloading
- Production building script
Once the installation finishes, you can run some commands in your project:
Runs the app in the development mode.
Open http://localhost:4000/admin to view it in the browser.
The page will reload if you make edits.
You will also see any errors in the console.
Builds the app for production to the .burdy/build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
Starts the application in production mode. The application should be compiled with `npm run build` first.
Now you're ready to code & deploy your app!
We are grateful to the authors of existing related projects for their ideas as inspiration: