Esposter

Table of Contents

• 📖 Documentation
• 🏠 Local Development
• ⚖️ License

📖 Documentation

We highly recommend you take a look at the documentation to level up.

Frontend

	Nuxt 3 The Intuitive Web Framework, based on Vue 3. We highly recommend you take a look at the Nuxt documentation to level up.
	Vue 3 🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web. We highly recommend you take a look at the Vue 3 documentation to level up.
	Vuetify 3 🐉 Material Component Framework for Vue. We highly recommend you take a look at the Vuetify 3 documentation to level up.
	Pinia 🍍 Intuitive, type safe, light and flexible Store for Vue using the composition api with DevTools support. We highly recommend you take a look at the Pinia documentation to level up.

Backend

	tRPC 🧙‍♀️ Move Fast and Break Nothing. End-to-end typesafe APIs made easy. We highly recommend you take a look at the tRPC documentation to level up.
	Zod TypeScript-first schema validation with static type inference. We highly recommend you take a look at the Zod documentation to level up.
	Drizzle ORM TypeScript ORM that feels like writing SQL. We highly recommend you take a look at the Drizzle ORM documentation to level up.
	PostgreSQL PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance. We highly recommend you take a look at the PostgreSQL documentation to level up.

Hosting & Domain Providers

	Railway Infrastructure, Instantly. We highly recommend you take a look at the Railway documentation to level up.
	Namecheap ICANN-accredited domain name registrar providing domain name registration and web hosting. We highly recommend you take a look at the Namecheap documentation to level up.

VSCode Extensions

Name	Link
Vue - Official (Volar)	https://marketplace.visualstudio.com/items?itemName=Vue.volar
ESLint	https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint
Prettier - Code formatter	https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode
GitLens — Git supercharged	https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens
Powershell	https://marketplace.visualstudio.com/items?itemName=ms-vscode.PowerShell
Material Icon Theme	https://marketplace.visualstudio.com/items?itemName=PKief.material-icon-theme
Better Comments	https://marketplace.visualstudio.com/items?itemName=aaron-bond.better-comments
Dark++ Italic	https://marketplace.visualstudio.com/items?itemName=idbartosz.darkpp-italic

🏠 Local Development

1. Install dependencies:

pnpm i

2. Install PostgreSQL + PgAdmin.

3. Add .env file according to .env.example in packages/app directory.

Production

Build the application for production:

pnpm build

Locally preview production build:

pnpm preview

Checkout the deployment documentation for more information.

Development Server

1. Build the packages to be used by the application:

pnpm build:packages

2. Change to the app directory:

cd packages/app

3. Start the development server on http://localhost:3000

pnpm dev

Architecture

Esposter is a lerna + pnpm workspaces monorepo. Packages are used directly by the nuxt application via workspace:*.

Tools

https://devina.io/svg-minifier

⚖️ License

Apache-2.0 licensed