Ategon/Jamjar
1
0
Fork 0
mirror of https://github.com/Ategon/Jamjar.git synced 2025-02-12 06:16:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Benjamin Barbeau 2025-01-16 14:54:39 -05:00 committed by GitHub
parent c1693a3166
commit 9cc4f99e3d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -7,9 +7,16 @@ Frontend for a game jam site
- Typescript (language)
- Next.js (web framework)
- Tailwind (css framework)
- Lucide (icons)
- Eslint (static code analysis)
- Framer motion (animations)
- React Toastify (toasts)
## Running for development
Prerequisites:
- node.js or equivalent
To start up the site locally for development you need to:
1. Go to a spot you want to be the parent folder for where the folder for Jamjar goes (e.g. navigate to it in terminal)
@ -25,4 +32,7 @@ NEXT_PUBLIC_MODE=DEV
## Running using docker
Prerequisites:
- docker
If you want to start up the frontend using docker instead of what is above (either for development or for a production site) you can run `docker compose up --build -d` to build the image and then run it in the background