4chan-XZ/README.md
2023-05-09 01:00:16 +02:00

51 lines
1.0 KiB
Markdown

# 4chan XZ
**This repo is work in progress!** Use the build from the [repo this is forked from](https://github.com/ccd0/4chan-x) in the meantime.
PR to upstream: <https://github.com/ccd0/4chan-x/pull/3341>.
## What is this?
This is a fork of [4chan X](github.com/ccd0/4chan-x) that aims to make it more modern, and easier to maintain.
## Why?
4chan X is a great extension, but it's a bit old. It uses a lot of old technologies, and it's a bit hard to maintain. This fork aims to make it easier to maintain, and more modern.
## TODO
- [x] add typescript
- [] add types to all files
- [] make project use strict mode
- [] switch from fontawesome & pictures to svg icons.
- [] add tests
- [] add vite for development
- [] make it a chrome & firefox extension.
## Building the project
**Note:** THIS PROJECT IS FAR FROM BEING DONE. DO NOT USE IT FOR NON-DEVELOPMENT YET.
```npm
pnpm install
pnpm run build
```
or as i prefer
```bash
make sneed
```
## What might be added on
- [] add React, or Vue
- [] add the auto-captcha solver to BTFO jannies