feat(docs): add docs

regardscitoyens · Dec 9, 2023 · 9e40841 · 9e40841
1 parent 8684106
commit 9e40841
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/.env.example b/.env.example
@@ -0,0 +1,6 @@
+# .env.local
+DB_HOST=51.159.207.103
+DB_PORT=1695
+DB_USER=default_user
+DB_PASSWORD=...
+DB_DATABASE=tricoteuses
diff --git a/README.md b/README.md
@@ -1,3 +1,12 @@
+
+# Documentation
+
+## Database
+
+The project uses a postGreSQL database, the env variables need to be set in .env.local to connect to the database. See env.example for an example.
+
+# Autogenerated Nextjs documentation
+
 This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
 
 ## Getting Started