feat: new development workflow setup (#42)

Author: stabldev

.env.development

@@ -1,2 +1,2 @@
 # DATABASE
-DATABASE_URL=postgresql://postgres:postgres@db:5432/postgres
+DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres

.env.example

@@ -1,4 +1,8 @@
 # DATABASE
+# if localhost:
+# DATABASE_URL=postgresql://postgres:postgres@localhost:5432/postgres
+# if docker:
+# DATABASE_URL=postgresql://postgres:postgres@db:5432/postgres
 DATABASE_URL=
 
 # SECRET

.gitignore

@@ -26,6 +26,7 @@ yarn-debug.log*
 yarn-error.log*
 
 # local env files
+.env
 .env*.local
 
 # vercel

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "files.associations": {
+    "Dockerfile*": "dockerfile",
+    ".env*": "shellscript"
+  },
+  "editor.tabSize": 4
+}

.zed/settings.json

@@ -0,0 +1,11 @@
+// Folder-specific settings
+//
+// For a full list of overridable settings, and general information on folder-specific settings,
+// see the documentation: https://zed.dev/docs/configuring-zed#settings-files
+{
+  "file_types": {
+    "Dockerfile": ["Dockerfile*"],
+    "Shell Script": [".env*"]
+  },
+  "tab_size": 2
+}

README.md

@@ -1,50 +1,78 @@
-```ts
-// WHOAMI
-export const metadata: Metadata = {
-  title: 'Moonlitgrace',
-  description:
-    'Step into Moonlitgrace, where a passionate web developer and
-    open-source contributor shares insights, projects, and
-    creativity—all under the alias Moonlitgrace.',
-};
-```
+# moonlitgrace.space
 
-## Development
+Step into Moonlitgrace, where a passionate web developer and open-source contributor shares insights, projects, and creativity—all under the alias Moonlitgrace.
 
-This is a containerized next.js app, so I recommend you to run it with docker or podman.
+### Table of Contents
 
-> [!IMPORTANT]
-> You can use [docker](https://www.docker.com/) or [podman](https://podman.io/)\
-> Here I will show you with podman.
+ - [Development](#development)
+   - [Basic Steps](#basic-steps)
+   - [Configure environment variables](#configure-environment-variables)
+   - [Run app on local](#run-app-on-local-traditional-workflow)
+   - [Run app on container](#run-app-on-container)
 
+## Development
 ### Basic Steps
 
-- `git clone https://github.com/moonlitgrace/space moonlitspace`
-- `cd moonlitspace`
+- `git clone https://github.com/moonlitgrace/moonlitgrace.space moonlitgrace.space`
+- `cd moonlitgrace.space`
 - `npm i`
 
 ### Configure environment variables
 
 From repo you will get 3 `.env` files such as:
 
-- `.env.development`
 - `.env.example`
+- `.env.development`
 - `.env.local.example`
 
-For development you only have to change `.env.local.example` like:
+Check [Environment Variable Load Order](https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables#environment-variable-load-order) for more information regarding this structure.
 
-- First create `.env.local` with:
-  `cp .env.local.example .env.local`
-
-For `SECRET_KEY` you can use anything since it is for development. You can use this `openssl rand -base64 32` to create for production.
+For `SECRET_KEY` you can use anything since it is for development. (You can use this `openssl rand -base64 32` to create for production.)
 
 As for `ADMIN_USERNAME` and `ADMIN_PASSWORD` add something to authenticate only you.
 
-### Run containers
+`DATABASE_URL`: uncomment value according to your selected workflow (see next heading).
+
+## Run app on local (traditional workflow)
+
+Before running `app`, we need a postgres `db` running.\
+You can either run `db` on your system or use docker/podman.
 
-After setting required env variables, let's start containers with one command:\
-`podman-compose -f docker-compose.dev.yml up -d --build`
+eg postgresql connection string format: `postgresql://[db_user[:db_password]@][db_host][:db_port]/[db_name]`
+
+If you've docker/podman installed, you can run `db` on a container with command:
+```bash
+# docker compose -f docker-compose.db.yml up
+podman compose -f docker-compose.db.yml up
+```
+
+Now `db` is up!\
+Next run database migrations with commands:
+```bash
+# can use any package manager
+npm run db:generate
+npm run db:migrate
+```
+
+If you want some mock data for development: run: `npm run db:seed`
+
+To get `next.js` app running, run this command:
+```bash
+npm run dev
+```
+
+And that's for now! check [localhost:3000](https://localhost:3000) to see app running!
+
+## Run app on container
+
+(un)fortunately this app is containerized, so you can easily run it with docker/podman/any(idk).\
+Just run this command:
+```bash
+# docker compose -f docker-compose.dev.yml up --build
+podman compose -f docker-compose.dev.yml up --build
+```
 
-And that's it, docker will setup everything for you, and once its done, visit: `http://localhost:3000`\
+This will run app on [localhost:3000](https://localhost:3000), hurray?
 
-Consider [issue tracker](https://github.com/moonlitgrace/space/issues) if you see any problem setting it up, happy coding!
+> Next.js on container is not fun imho.\
+> recommended: local setup

db/seed/seed.ts

@@ -1,3 +1,4 @@
+import 'dotenv/config';
 import { db } from '@/db';
 import { posts } from '@/db/schema';
 import { postsMockData } from './mock/posts';
@@ -18,4 +19,4 @@ async function main() {
   }
 }
 
-main();
+// main();

docker-compose.db.yml

@@ -0,0 +1,17 @@
+version: '3'
+
+services:
+  db:
+    image: postgres:16.4-alpine
+    restart: always
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: postgres
+      POSTGRES_DB: postgres
+    ports:
+      - 5432:5432
+    volumes:
+      - pgdata:/var/lib/postgresql/data
+
+volumes:
+  pgdata: {}