Skip to content

Commit

Permalink
Updated readme for database handling
Browse files Browse the repository at this point in the history
  • Loading branch information
LobeTia committed Jan 20, 2025
1 parent f638c35 commit 9a109af
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
Project description

### Tech stack

- [Next.js](https://nextjs.org)
- [Tailwind CSS](https://tailwindcss.com)
- [tRPC](https://trpc.io)
Expand All @@ -67,6 +68,7 @@ Project description
### Project setup

Ensure you have installed

```
node >= 20.10.0
npm >= 10.2.3
Expand Down Expand Up @@ -96,9 +98,24 @@ npm run build
npm run lint:fix
```

<!-- DATABASE -->

## Database

If you have Docker installed, you can create a database with the following command:

```
./start-database.sh
```

```
npm run db:migrate
```

<!-- ROADMAP -->

## 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.
Expand Down Expand Up @@ -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
[issues-url]: https://github.com/schroedinger-Hat/schroedinger-hat-website/issues

0 comments on commit 9a109af

Please sign in to comment.