Skip to content

Latest commit

 

History

History
49 lines (31 loc) · 2.35 KB

README.md

File metadata and controls

49 lines (31 loc) · 2.35 KB
Raw

Welcome to Wasp Starters 👋

In this repository you'll find some of the starters to speed up your initial project with Wasp Lang

If you don't already have it, you can install Wasp by going here.

Available starters

Note After you create a new project, make sure to check the README.md to see any additional info

Todo App w/ Typescript

A simple Todo App with Typescript and Fullstack Type Safety.

Features: Auth (username/password), Fullstack Type Safety

Use this template:

wasp new <project-name> -t todo-ts

Vector Similarity Search Template

A template for generating embeddings and performing vector similarity search on your own text data!

Features: w/ Embeddings & vector similarity search, OpenAI Embeddings API, Vector DB (Pinecone), Tailwind, Fullstack Type Safety

Use this template:

wasp new <project-name> -t embeddings

SaaS Template

A SaaS Template to get your profitable side-project started quickly and easily!

It used to be here, but now it became big enough to have its own repo: check it out at https://github.com/wasp-lang/open-saas .

If you are looking to contribute a template

Adding a new template includes:

  1. Create a new folder in the root of the repo and write the Wasp app code in it, for whatever you want your template to be.
  2. Put the placeholders in main.wasp instead of the app name and title, if you wish (check how other templates do this).
  3. Create a PR! In the PR, ask a core team do add template to the list of templates in the code of Wasp CLI, in https://github.com/wasp-lang/wasp/blob/main/waspc/cli/src/Wasp/Cli/Command/CreateNewProject/StarterTemplates.hs . You could also do this on your own, but it involves Haskell and setting it up might be quite time consuming if you never used it before, so we advise leaving it to the core team.

Core team: tag management

If we updated templates for the existing wasp version, then we also need to update the tag that current wasp uses to fetch the templates to point to our latest changes. If new major version of wasp came out and we want to update the templates so they work with this new version of wasp, then we should not touch existing tags but should instead create a new tag that corresponds to the one that new wasp expects, and we should make it point to our latest changes.