From 9a109af1ccbfb40741ec0095a493146251e2110a Mon Sep 17 00:00:00 2001 From: lobetia Date: Mon, 20 Jan 2025 22:42:13 +0100 Subject: [PATCH] Updated readme for database handling --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d16bdb..b9eb24a 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,7 @@ Project description ### Tech stack + - [Next.js](https://nextjs.org) - [Tailwind CSS](https://tailwindcss.com) - [tRPC](https://trpc.io) @@ -67,6 +68,7 @@ Project description ### Project setup Ensure you have installed + ``` node >= 20.10.0 npm >= 10.2.3 @@ -96,9 +98,24 @@ npm run build npm run lint:fix ``` + + +## Database + +If you have Docker installed, you can create a database with the following command: + +``` +./start-database.sh +``` + +``` +npm run db:migrate +``` + ## Roadmap + Currently working on some improvements after initial release. Check out the [milestone](https://github.com/schroedinger-Hat/schroedinger-hat-website/milestones) and the the [open issues](https://github.com/schroedinger-Hat/schroedinger-hat-website/issues) if you would like to contribute. @@ -132,4 +149,4 @@ Don't forget to give the project a star! Thanks again! [forks-shield]: https://img.shields.io/github/forks/schroedinger-Hat/schroedinger-hat-website.svg?style=for-the-badge [forks-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/network/members [issues-shield]: https://img.shields.io/github/issues/schroedinger-Hat/schroedinger-hat-website.svg?style=for-the-badge -[issues-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/issues \ No newline at end of file +[issues-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/issues