From 9e408410032cfa0a4d23d5ebacfb1af1a11e1f22 Mon Sep 17 00:00:00 2001 From: Louis Sanna Date: Sat, 9 Dec 2023 16:01:39 +0100 Subject: [PATCH] feat(docs): add docs --- .env.example | 6 ++++++ README.md | 9 +++++++++ 2 files changed, 15 insertions(+) create mode 100644 .env.example diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..0f05fec --- /dev/null +++ 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 \ No newline at end of file diff --git a/README.md b/README.md index fc89c64..a7d3585 100644 --- 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