minBin

Minimal & self-hostable pastebin alternative, intended for code or short text snippets

Prerequisites

You'll need the following properly installed on your system:

Installing

git clone [email protected]:kiosion/minbin.git this repository
cd minbin
make install to install deps for both frontend app and api

Running / Development

make dev-{api,app} (development servers)
View the app at https://localhost:4200.
View the tests at https://localhost:4200/tests.

Running Tests

make test

Linting

make lint
make lint-fix

Building

make build-{api,app} (production webpack'd versions)

Deploying

docker-compose build --no-cache to build fresh docker containers
docker-compose up -d to run the containers in the background
API will be available at localhost:3000, frontend at localhost:4200. These can then be proxied to a domain of your choice.

Contributing

Contributions are welcome! Please open an issue or PR if you have any suggestions or find any bugs.

License

This project is licensed under the MIT License - see LICENSE.md for details.