paste69/README.md

48 lines
1.2 KiB
Markdown
Raw Normal View History

2024-01-03 00:54:12 +00:00
# Paste69
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
This project has undergone several changes, but here's where we are now:
Paste69 is a clone of the popular pastebin service 0x45.st, but written in Crystal using [the Athena framework](https://athenaframework.org/) rather than in Python with Flask.
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
## Installation
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
Installation requires [Crystal](https://crystal-lang.org/) and Postgres. Other databases might be supported in the future.
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
Clone this repo:
2023-10-06 23:08:13 +00:00
```bash
2024-01-03 00:54:12 +00:00
git clone https://github.com/watzon/paste69
2023-10-06 23:08:13 +00:00
```
2024-01-03 00:54:12 +00:00
Install dependencies:
```bash
shards install
```
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
Copy and modify the config file:
2023-10-06 23:08:13 +00:00
```bash
2024-01-03 00:54:12 +00:00
cp config/config.example.yml config/config.yml
vim config/config.yml
```
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
Build the executables, migrate the database, and run the server:
```bash
shards build
./bin/cli db:migrate # this assumes the dabase exists, if not run db:create first
./bin/server
2023-10-06 23:08:13 +00:00
```
2024-01-03 00:54:12 +00:00
## Development
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
Feel free to make pull requests!
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
## Contributing
1. Fork it (<https://github.com/watzon/paste69/fork>)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
## Contributors
2023-10-06 23:08:13 +00:00
2024-01-03 00:54:12 +00:00
- [Chris W](https://github.com/watzon) - creator and maintainer