29 lines
1.0 KiB
Markdown
29 lines
1.0 KiB
Markdown
# Building guide
|
|
|
|
## Prerequisites
|
|
|
|
- [node](https://nodejs.org/en/download) v22.22.0+
|
|
- npm v10.9.4+
|
|
- git v2.34.1+
|
|
|
|
Other versions may work, they are simply untested.
|
|
|
|
## Guide
|
|
|
|
1. Clone the repo: `git clone https://git.dou.bet/iamdoubz/drawit.git`
|
|
2. Enter the repo: `cd drawit`
|
|
3. Install DrawIt's dependencies: `npm install --omit=dev`
|
|
4. Copy env example: `cp .env.example .env.local`
|
|
5. Edit `.env.local` to match your environment: `nano .env.local`
|
|
|
|
**NOTE:** be sure to generate a long and unique `SESSION_SECRET`. Recommendation: `openssl rand -hex 32`
|
|
|
|
6. Build the production assets: `npm run build`
|
|
7. OPTIONALLY, check the TypeScript files: `npm run typecheck`
|
|
8. Start the server: `npm run start`
|
|
|
|
You should now be running your very own DrawIt instance!
|
|
|
|
## Additional reading
|
|
|
|
After you know *it works!*, you should set up an [init startup service](AUTO_STARTING.md) and [reverse proxy](REVERSE_PROXIES.md). |