KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #codex #typescript #developer-tools #ai-agents #deepseek-harness #claude-code #ai-agent #cli #react #mcp

pole-pedia

★ 5 Open GitHub ↗

A cheap wikipedia rip off that uses Remix under the hood.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Pole Pedia

![Pole Pedia](https://raw.githubusercontent.com/kevinleiba/pole-pedia/master/app/components/icons/logo.svg)

A cheap wikipedia rip off that uses [Remix](http://remix.run) under the hood.

## Development

Initial setup:

```sh
npm run setup
```

Start dev server:

```sh
npm run dev
```

## Deployment

```sh
npm run build
npm start
```

## Connecting to your database

This project uses `postgresql`. Configure your `.env` file with corresponding informations.

You can then use `npx prisma db push` to create the db for you, but it won't create the schemas for you (because project uses some specific postgresql extension that is specified in migration files).

So use `npx prisma migrate dev`.

You can seed it `npx prisma db seed`.

## Testing

### Cypress

```bash
npm run test:e2e:dev # run end to end tests. Setup your .env.teste2e file.
```

### Vitest

```bash
npm run test # runs unit tests and components tests
npm run test:db # runs database tests. You might want to setup your .env.test file for that
```

### Type Checking

This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run `npm run typecheck`.

### Linting

This project uses ESLint for linting. That is configured in `.eslintrc.js`.

### Formatting

We use [Prettier](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project.

pole-pedia

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README