Spartan

screenshot of Spartan

Cutting-edge tools powering Angular full-stack development.

Overview

The spartan repository is a work in progress project with two main efforts:

spartan/ui - an effort to port the shadcn/ui project into the Angular ecosystem. This involves creating unstyled primitives similar to Radix using Angular Cdk and other community solutions, and then adding the shadcn styles to these primitives.
spartan/stack - an example application running on Supabase, Drizzle, Analog, tRPC, Tailwind, Angular, and Nx. It serves as both the documentation page introducing the stack and UI library.

Features

Porting of 30 out of 41 UI primitives from shadcn/ui to Angular ecosystem
Storybook project for UI primitives
Cypress e2e testing set up for storybook
Example application running on multiple technologies including Supabase, Drizzle, Analog, tRPC, Tailwind, Angular, and Nx
Documentation page introducing the stack and UI library

Prerequisites

Install yarn (or a different package manager)
Set up a Supabase account (free)
Install NodeJs (version 18.13.0)

Install Dependencies

Run the following command in the project directory to install the dependencies:

yarn install

Set up DB

This project requires Prisma for database management.
Use Supabase as the database provider (an open-source alternative to Firebase with a Postgres database, Authentication, instant APIs, Edge Functions, Realtime subscriptions, and Storage).

Connect to DB

There are two ways to connect to Supabase:

Connecting directly to your managed instance on supabase.com
- Create an account and set up your first project.
- Add the following code snippet to a .env file at the root of your Nx workspace:
```
// .env
SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key
```
Connecting to a local Supabase instance
- Follow the Supabase guide for instructions on setting up a local instance.

Create Supabase project

Start Supabase services with the appropriate Docker configuration.

Summary

The spartan repository is an ongoing project with two main efforts: porting the shadcn/ui project to Angular ecosystem and creating an example application running on various technologies. It provides UI primitives, a storybook project, e2e testing, and a documentation page for the stack and UI library. To use the example application, install the prerequisites, dependencies, and connect to a Supabase instance.

screenshot of Spartan

Analog: Analog is a fullstack meta-framework for Angular, similar to what Nuxt is for Vue or Next.js is for React. It provides file-based routing, API routes, server-side rendering, and static site generation for Angular applications.
Angular: Angular is a TypeScript-based open-source framework by Google for building dynamic single-page applications and cross-platform mobile apps with MVC architecture and a rich set of features.
Vite: Vite is a build tool that aims to provide a faster and leaner development experience for modern web projects
LESS: Less CSS is a dynamic stylesheet language that extends the capabilities of CSS, allowing developers to write cleaner, more modular, and reusable stylesheets with features like variables, mixins, and nested rules.
Tailwind: Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
Drizzle ORM: Drizzle ORM is a TypeScript ORM for SQL databases designed with maximum type safety in mind. It comes with a drizzle-kit CLI companion for automatic SQL migrations generation. Drizzle ORM is meant to be a library, not a framework. It stays as an opt-in solution all the time at any levels.
Fullstack: A fullstack boilerplate provides a starter application that includes both frontend and backend. It should include database, auth, payments, user roles and other backend services to build a fully featured saas or webapps.
UI Kits & Components: A UI kit provides developers with a set of reusable components that can be easily integrated into a website or application. These components are pre-designed with consistent styling and functionality, allowing developers to save time and effort in the design and development process. UI kits can be either custom-built or third-party, and often include components for buttons, forms, typography, icons, and more.
Eslint: ESLint is a linter for JavaScript that analyzes code to detect and report on potential problems and errors, as well as enforce consistent code style and best practices, helping developers to write cleaner, more maintainable code.
Postcss: PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.
Prism JS: PrismJS is an open-source, lightweight, and extensible syntax highlighting library that supports a wide range of programming languages and markup formats.
Rollup: RollupJS is a popular and efficient JavaScript module bundler that takes the code from multiple modules and packages them into a single optimized file, minimizing the overall size of the application and improving its performance.
Storybook: Storybook is a tool for developing and testing UI components in isolation. It provides a sandbox environment where you can experiment with different props and states to see how your component responds.
Typescript: TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
Zod: Zod is a TypeScript-first schema declaration and validation library. It allows you to define schemas that can validate data at runtime while providing excellent TypeScript inference, making it perfect for API validation, form validation, and type-safe data handling.