Warning: this project is in beta. Design, workflows, and user accounts are subject to change.
todo discord link
Deno CultKit is an open-sourced, highly performant template for building your Cult quickly and easily.
- No build step
- Deno's built-in formatter, linter and test runner and TypeScript support.
- Database management and user authentication with Deno KV, which provides zero config durable data storage. _Prefer using Supabase for data storage?
- Billing management with Alchemy.
- Fresh as the web framework and Tailwind CSS as the CSS framework.
- Clone the repo:
git clone https://github.com/denoland/saaskit.git
cd saaskit- Create a
.envfile to store environmental variables:
cp .example.env .env
- Register a new GitHub OAuth application with the following values:
Application name= a name of your own choosingHomepage URL=http://localhost:8000Authorization callback URL=http://localhost:8000/callback
- Once registered, copy the
Client IDvalue to theGITHUB_CLIENT_IDvalue in your.envfile. - Click
Generate a new client secretand copy the resulting client secret to theGITHUB_CLIENT_SECRETenvironment variable in your.envfile.
- Copy your Stripe secret key as
STRIPE_SECRET_KEYinto your.envfile. We recommend using the test key for your development environment. - Run
deno task init:stripeand follow the instructions. This automatically creates your "Premium tier" product and configures the Stripe customer portal.
Note: go to tools/init_stripe.ts if you'd like to learn more about how the
init:stripetask works.
- Listen locally to Stripe events:
stripe listen --forward-to localhost:8000/api/stripe-webhooks --events=customer.subscription.created,customer.subscription.deleted
- Copy the webhook signing secret to .env as
STRIPE_WEBHOOK_SECRET.
Finally, start the server by running:
deno task start
Go to http://localhost:8000 to begin playing with your new Cult app.
Note: You can use Stripe's test credit cards to make test payments while in Stripe's test mode.
The utils/constants.ts file includes global values used across various aspects of the codebase. Update these values according to your needs.
To create a new blog post, create a Markdown (.md) file within
/data/posts/ with the filename as the slug. E.g.
/data/blog/hello-there.md will correspond to the /blog/hello-there route.
See /data/posts/ for examples.
Post properties are to be added to the starting Front Matter section of the
Markdown file. See the Post interface in /utils/posts.ts
for a full list of properties and their types.
You can customize theme options such as spacing, color, etc. By default, Deno
CultKit comes with primary and secondary colors predefined within
twind.config.ts. Change these values to match your desired color scheme.
This section assumes that a local development environment has been set up.
- Change your OAuth app settings to the following:
Homepage URL=https://{{ YOUR DOMAIN }}Authorization callback URL=http://{{ YOUR DOMAIN }}/callback
todo
todo
When submitting a pull request, please follow the Deno Style Guide.
Before submitting, run the following to check the formatting, linting, licenses, and types and run tests in one hit:
deno task ok
For the user, the website should be fast, secure and have a design with clear intent. Additionally, the HTML should be well-structured and indexable by search engines. The defining metrics for these goals are:
- A perfect PageSpeed Insights score.
- Fully valid HTML, as measured by W3C's Markup Validation Service.
For the developer, the codebase should minimize the steps and amount of time required to get up and running. From there, customization and extension of the web app should be simple. The characteristics of a well-written codebase also apply, such as:
- Easy to understand
- Modular functionality
- Clearly defined behavior with validation through tests
Join
the #saaskit channel in Deno's Discord
to meet other CultKit developers, ask questions, and get unblocked.
Here's a list of articles, how to guides, and videos about CultKit: