diff --git a/README.md b/README.md index 9c6d1a4..0675eb5 100644 --- a/README.md +++ b/README.md @@ -29,15 +29,21 @@ - [π Documentation ](#-documentation-) - [π Getting Started ](#-getting-started-) - [πΈοΈ Prerequisites](#οΈ-prerequisites) - - [Backend:](#backend) - - [Admin panel:](#admin-panel) + - [Backend](#backend) + - [Admin panel](#admin-panel) - [π Deployment ](#-deployment-) + - [Backend](#backend-1) + - [Admin Panel](#admin-panel-1) - [βοΈ Built Using ](#οΈ-built-using-) - [βοΈ Authors ](#οΈ-authors-) ## π§ About -I really need to get my hands dirty from time to time, so I figured I'd make a guestbook for my marriage hotsite. And make everyone else see this code. +Guestbooky proposes something slightly deviating from the usual guestbook taken from 1998: while we gladly accept your messages, thank you very much, reading them is limited to the receiver. *I mean, of course they can show them to others should they want-* + +
+ +That means it is something useful for engaged couples and other folks with a moment or two to set everything up. I really need to get my hands dirty from time to time, so I figured I'd make a guestbook for my marriage hotsite. And make everyone else see this code. It includes many concepts that are very reasonable to tinker with as learning material, in a bite-sized project complexity that allows me to talk about it without losing the breadcrumb trail. @@ -51,7 +57,7 @@ These instructions will get you a copy of the project up and running on your loc ## πΈοΈ Prerequisites -### Backend: +### Backend For running it locally: - .NET 8.0 @@ -88,16 +94,30 @@ You will be able to see in `build/docker-compose.public.yml` that the applicatio > [!TIP] > For local usage of the backend, you can use `docker-compose.local.yml` and edit the fields you need. -### Admin panel: +### Admin panel -The admin panel is a simple React/Vite app. For development, it should be enough to run `vite` in Guestbooky-admin's `src` folder. +The admin panel is a simple React app built through Vite. -In order to create a live version, adjust the **API_URL** path in `Guestbooky-admin/src/environment/constants.js`, and execute `vite build`. +If you haven't done so, the prerequisites are: + +- Node v18+ +- NPM or any other package manager +- Vite + +Using [nvm](https://github.com/nvm-sh/nvm) should make things straightforward enough for your environment if you don't have Node up yet. Then do the usual `npm i` (or equivalent) in the Admin Panel's `src/Guestbooky-admin` folder and such to get the packages, which should include Vite. + +For development, it should be enough to run `vite` in Guestbooky-admin's `src` folder. ## π Deployment +### Backend + Use `docker-compose.public.yml` as a basis. it should create the image for you and start running. +### Admin Panel + +In order to create a live version, adjust the **API_URL** path in `Guestbooky-admin/src/environment/constants.js`, and execute `vite build`. The application will be prepared and sent to `src/Guestbooky-admin/dist`. Send to your hosting solution and you should be good. + ## βοΈ Built Using - [MongoDB](https://www.mongodb.com/) - Database diff --git a/docs/guestbooky-admin.png b/docs/guestbooky-admin.png new file mode 100644 index 0000000..049ed9c Binary files /dev/null and b/docs/guestbooky-admin.png differ diff --git a/src/Guestbooky-admin/vite.config.js b/src/Guestbooky-admin/vite.config.js index 8b0f57b..d40796b 100644 --- a/src/Guestbooky-admin/vite.config.js +++ b/src/Guestbooky-admin/vite.config.js @@ -4,4 +4,5 @@ import react from '@vitejs/plugin-react' // https://vite.dev/config/ export default defineConfig({ plugins: [react()], + base: './', })