Twi

Fanfiction library engine

First of all, you'll need MySQL v8, Node.js v20 (latest version would be preferrable) and docker with docker compose (to run tests).

Before you begin:

Create a .env.development.local file and fill with required environment variables
Create a database with the name you specified in DB_NANE variable

Then, make sure to install the dependencies:

pnpm i

Development Server

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

pnpm run dev

Build the application for production:

pnpm run build

Locally preview production build:

pnpm run preview

Name	Required	Default value	Description
DB_NAME	Yes	—	Database name
DB_HOST	No	`"localhost"`	Database server host
DB_PORT	No	`3306`	Database server port
DB_USER	Yes	—	Database user
DB_PASSWORD	Yes	—	Database password
AUTH_ORIGIN	Yes	—	Server address for auth callbacks. The `origin` part of a URL
AUTH_SECRET	Yes	—	Auth secret for Cookies

Name		Name	Last commit message	Last commit date
Latest commit History 1,836 Commits
.github		.github
.husky		.husky
assets		assets
components		components
composables		composables
layouts		layouts
lib		lib
pages		pages
plugins		plugins
public		public
scripts/tests		scripts/tests
server		server
uploads		uploads
.editorconfig		.editorconfig
.env.example		.env.example
.eslintignore		.eslintignore
.eslintrc.cjs		.eslintrc.cjs
.gitignore		.gitignore
.lintstagedrc		.lintstagedrc
app.vue		app.vue
code_of_cunduct.md		code_of_cunduct.md
commitlint.config.ts		commitlint.config.ts
docker-compose.test.yaml		docker-compose.test.yaml
env.d.ts		env.d.ts
license		license
next-auth.d.ts		next-auth.d.ts
nuxt.config.ts		nuxt.config.ts
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
readme.md		readme.md
tailwind.config.ts		tailwind.config.ts
tsconfig.json		tsconfig.json
type-is.d.ts		type-is.d.ts
vitest.config.ts		vitest.config.ts
vitest.workspace.ts		vitest.workspace.ts