haetae.tngl.sh
experimenting with making decentralized fanfic archives on atproto. github mirror: https://github.com/haetae-bit/fanfic-atproto
update readme to include contrib and support links
+33
-1
+33
-1
README.md
+33
-1
README.md
···
6
6
- [Notes](#notes)
7
7
- [Structure](#structure)
8
8
- [Contributing](#contributing)
9
+
- [Support](#support)
9
10
10
11
> [!WARNING]
11
12
> This is alpha software, there's no guarantee that this will work on your system. But if you'd like to try hacking at this, take a look at the [Contributing](#contributing) section once instructions are written up.
···
79
80
80
81
## Contributing
81
82
82
-
To be added, but feel free to open an issue in the meantime!
83
+
The instructions may change in the future in case the development workflow changes. Please feel free to [report an issue](/issues) if you come across any during development or building.
84
+
85
+
### Prerequisites
86
+
87
+
- Git
88
+
- Node.js
89
+
- `v18.20.8` or `v20.3.0`, `v22.0.0` or higher. (`v19` and `v21` are not supported.)
90
+
- `npm` or similar package manager
91
+
92
+
> [!IMPORTANT]
93
+
> Running this with `deno` does not work. You'll get an "Unsupported key curve for this operation" error when running the project and testing OAuth. See [this issue](https://github.com/panva/jose/discussions/740).
94
+
95
+
### Instructions
96
+
97
+
1. Clone the repo to your system using the following command:
98
+
```bash
99
+
git clone https://github.com/haetae-bit/fanfic-atproto
100
+
```
101
+
2. Use whatever runtime you use to install packages:
102
+
```bash
103
+
npm install
104
+
```
105
+
3. To run the development server, use this command:
106
+
```bash
107
+
npm run dev
108
+
```
109
+
110
+
## Support
111
+
112
+
If you want to support me making making this, please feel free to donate a coffee.
113
+
114
+
<script type="text/javascript" src="https://cdnjs.buymeacoffee.com/1.0.0/button.prod.min.js" data-name="bmc-button" data-slug="haetae" data-color="#BD5FFF" data-emoji="☕" data-font="Comic" data-text="Buy me a coffee" data-outline-color="#000000" data-font-color="#ffffff" data-coffee-color="#FFDD00" ></script>