add node documentation, todo

2025-01-24 18:32:04 -05:00 · 2025-01-24 18:32:04 -05:00 · 05f9be8493
commit 05f9be8493
parent c47438c033
1 changed files with 84 additions and 2 deletions
--- a/README.md
+++ b/README.md
@ -1,5 +1,87 @@
-# blogpop
-[![Last Update](https://img.shields.io/badge/last_update-15_Jan_2025-blue)](#)
+# BlogPop
+
+[![Last Update](https://img.shields.io/badge/last_update-15_Jan_2025-blue)](https://git.pontusmail.org/abocn/blogpop)

 A simple blogging platform built with Next.js, shadcn/ui and Tailwind CSS.

+## Bun/Node Setup
+
+1. **Clone repository**
+
+   ```bash
+   git clone https://git.pontusmail.org/abocn/blogpop.git
+   cd blogpop
+   ```
+
+2. **Install dependencies and copy files**
+
+   **Frontend:**
+
+   ```bash
+   npm install # npm
+   bun install # or bun
+   ```
+
+   **Backend:**
+
+   ```bash
+   cd server/
+   npm install # bun is not suggested
+   ```
+
+   **Copy example .env:**
+
+   ```bash
+   cp .env.example .env
+   nano .env # edit if you desire
+   ```
+
+3. **Start server**
+
+   Starting a dev server with Node or Bun requires two terminals. One will output the log files for the backend, and the other will output the log files for the frontend.
+
+   **Start a dev server:**
+
+   ```bash
+   bun dev # Terminal 1
+   cd server/ # Terminal 2
+   bun index.js # Terminal 2
+   ```
+
+   *OR*
+
+   ```bash
+   npm run dev # Terminal 1
+   cd server/ # Terminal 2
+   node index.js # Terminal 2
+   ```
+
+   Whichever option you selected, your frontend will be served on port `3000` by default, though you can change that in your `.env` file. The API will be accessible on `3001`.
+
+   **Start production server:**
+
+   Starting a production server with Node or Bun will also require two terminals. One will output the log files for the backend, and the other will output the log files for the frontend.
+
+   ```bash
+   bun run build # Terminal 1
+   bun start # Terminal 1
+   cd server/ # Terminal 2
+   node index.js # Terminal 2
+   ```
+
+   *OR*
+
+   ```bash
+   bun run build # Terminal 1
+   bun start # Terminal 1
+   cd server/ # Terminal 2
+   node index.js # Terminal 2
+   ```
+
+   Whichever option you selected, your frontend will be served on port `3000` by default, though you can change that in your `.env` file. The API will be accessible on `3001`.
+
+## To-Do
+
+- [ ] Implement a logout animation on `/admin/logout`
+- [ ] Add a post list w/ management options on `/admin/posts`
+- [ ] Add a user list w/ management options in `/admin/users`