update readme.md

This commit is contained in:
Joonas 2023-01-14 13:43:45 +02:00
parent a2e9314724
commit 5674cc3d59
1 changed files with 18 additions and 42 deletions

View File

@ -1,53 +1,29 @@
# Welcome to Remix!
# Imageboard
- [Remix Docs](https://remix.run/docs)
## About
An imageboard made with Remix, with an SQLite database, using Prisma ORM.
Not ready for production yet, but you can try.
## Development
From your terminal:
```sh
npm run dev
git clone https://git.disroot.org/qwertyasdfgh/imageboard
cd imageboard
pnpm install
pnpm prisma db push
pnpm run dev
```
This starts your app in development mode, rebuilding assets on file changes.
## Deployment
First, build your app for production:
## Production
```sh
npm run build
git clone https://git.disroot.org/qwertyasdfgh/imageboard
cd imageboard
pnpm install
pnpm prisma db push
pnpm run build
pnpm start
```
Then run the app in production mode:
```sh
npm start
```
Now you'll need to pick a host to deploy it to.
### DIY
If you're familiar with deploying node applications, the built-in Remix app server is production-ready.
Make sure to deploy the output of `remix build`
- `build/`
- `public/build/`
### Using a Template
When you ran `npx create-remix@latest` there were a few choices for hosting. You can run that again to create a new project, then copy over your `app/` folder to the new project that's pre-configured for your target server.
```sh
cd ..
# create a new project, and pick a pre-configured host
npx create-remix@latest
cd my-new-remix-app
# remove the new project's app (not the old one!)
rm -rf app
# copy your app over
cp -R ../my-old-remix-app/app app
```
Run behind reverse proxy like NGINX