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

Git configuration to enable symlinks

The projects make use of symlinks in the git project. On Windows, this may not work as expected without extra configuration. To configure git to create symlinks on windows, you need to enable the Windows "Developer Mode" setting, and also set the core.symlinks git feature using either of the following commands:

# Global setting
git config --global core.symlinks true

# Local setting
git config core.symlinks true
Copy

After applying this setting, you may need to reset your local branch to ensure the files get rewritten as symlinks. Note that this step is destructive and you will want to push any changes you have made prior to resetting your branch.

git reset --hard
Copy

Installing Dependencies

1. Install Node Modules:

pnpm i
Copy

2. Install PostgreSQL + PgAdmin.

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

Checkout the deployment documentation for more information.

Development Server

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

pnpm build:packages
Copy

2. Change to the app directory:

cd packages/app
Copy

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

pnpm dev
Copy

Production

Build the application for production:

pnpm build
Copy

Locally preview production build:

pnpm preview
Copy

Architecture

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

Miscellaneous Tools

https://devina.io/svg-minifier

⚖️ License

This project is licensed under the Apache-2.0 license.