Updated README
This commit is contained in:
22
README.md
22
README.md
@@ -1,6 +1,26 @@
|
||||
# Setup
|
||||
|
||||
Install MariaDB/MySQL
|
||||
Install Git
|
||||
Install Node 19+
|
||||
|
||||
npm install --legacy-peer-deps
|
||||
|
||||
To run:
|
||||
npm run dev
|
||||
|
||||
To build:
|
||||
Add any background images to public/backgrounds to include them in the build
|
||||
npm run build
|
||||
|
||||
Run with pm2:
|
||||
npm install -g pm2
|
||||
sudo pm2 serve ./dist --no-daemon --spa --port 3000
|
||||
|
||||
|
||||
# TODO
|
||||
- Image uploads for backgrounds
|
||||
|
||||
- Create actions section
|
||||
|
||||
- Improve mobile
|
||||
- Improve mobile
|
||||
|
||||
Reference in New Issue
Block a user