https://github.com/fireisgood/friendless-commits
https://github.com/fireisgood/friendless-commits
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/fireisgood/friendless-commits
- Owner: FireIsGood
- Created: 2024-05-25T10:35:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T19:45:35.000Z (about 2 years ago)
- Last Synced: 2025-02-18T01:42:00.460Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Friendless Commits
> [!IMPORTANT]
> I haven't actually bought the domain yet, so the endpoints will not line up :(
> For when you want to lose all your friends.
A website and CLI endpoint to get questionable commit messages. Visit the site or add `?text` for a `curl` URL.
To add it as a bash command:
```bash
git config --global alias.yolo '!git commit -m "$(curl -s https://friendlesscommits.dev/all?text)"' # you may replace "all" with "safe" or "unsafe"
```
Heavily inspired by [What The Commit](https://github.com/ngerakines/commitment).
## For developers
How to run locally or develop...
## Running Locally
### Via bun
If you have bun installed, you can simply run:
```bash
bun install
bun run serve
```
### Via a docker container
First, copy the `example.docker-compose.yml` and `example.env.local` files to the actual file names:
```bash
cp ./example.docker-compose.yml ./docker-compose.yml
cp ./example.env.local ./env.local
```
To launch the docker container, run:
```bash
docker-compose up
```
The server runs on port `3000` by default with the base URL `https://friendlesscommits.dev/`. You can change these in
the `.env.local` file or in the `docker-compose.yml` file.
## Development
This project uses the bun JS runtime. First, install dependencies:
```bash
bun install
```
Then, to start the development server run:
```bash
bun run dev
```
## Contributing
Contributions of code or commit messages are welcome!
You can add messages to [messages.ts](src/assets/messages.ts) in the corresponding category. For issues with the code,
feel free to make issues or pull requests.