README
¶
About Pagode
Pagode is a full-stack web application starter kit with expressive, elegant architecture. We believe development must be an enjoyable and creative experience to be truly fulfilling. Pagode takes the pain out of development by combining the power of Go with modern React, providing:
- Fast, type-safe backend with Go and Echo.
- Modern React frontend with InertiaJS bridge.
- Powerful ORM with Ent code generation.
- Built-in authentication and session management.
- Background job processing with SQLite queues.
- Admin panel auto-generated for all entities.
- Hot reload development experience.
Pagode is accessible, powerful, and provides tools required for large, robust applications.
Learning Pagode
Pagode has comprehensive documentation and examples to help you get started quickly with the framework
Getting Started
Dependencies
Ensure that Go is installed on your system.
Getting the Code
Start by checking out the repository. Since this repository is a template and not a Go library, you do not use go get.
git clone git@github.com:occult/pagode.git
cd pagode
Create an Admin Account
To access the admin panel, you need an admin user account. To create your first admin user, use the command-line:
make admin email=your@email.com
This will generate an admin account using that email address and print the randomly-generated password.
Start the Application
Before starting, install the frontend dependencies:
npm install
Then, start the Vite frontend development server:
npx vite
From within the root of the codebase, run:
make run
By default, you can access the application at localhost:8000. Your data will be stored in the dbs directory.
Live Reloading
For automatic rebuilding when code changes, install air and use:
make air-install
make watch
Credits
Thank you to all the following amazing projects for making this possible.
Documentation
Source Files
Directories