From c1693a3166c98288a0ab664eaff60113f4ab876e Mon Sep 17 00:00:00 2001
From: Benjamin Barbeau <73616169+Ategon@users.noreply.github.com>
Date: Thu, 16 Jan 2025 14:50:50 -0500
Subject: [PATCH 1/5] Update README.md
---
README.md | 26 +++++++++++++++++++-------
1 file changed, 19 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
index 4e202bb..a6c85df 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,27 @@
Frontend for a game jam site
-To run using next.js (for development)
+## Things used
-```
-npm i
-npm run dev
-```
+- Typescript (language)
+- Next.js (web framework)
+- Tailwind (css framework)
-To run using docker and docker compose
+## Running for development
+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)
+2. Clone the repository aka get a local copy of the files (e.g. by running `git clone https://github.com/Dare2Jam/Jamjar.git`)
+3. Go into the folder you just cloned in (e.g. using `cd Jamjar`)
+4. Install dependencies needed for the site (e.g. `npm i`)
+5. Create a `.env` file in the folder which is used for environment variables. In this you would set NEXT_PUBLIC_MODE to either PROD or DEV depending on what backend data you want to load in (dev loads it from a locally running jamcore, PROD loads it from the production site)
```
-docker compose up --build -d
+NEXT_PUBLIC_MODE=DEV
```
+6. Run the site using `npm run dev` which will start up a dev server that will hot reload as you make changes (most of the time)
+7. Go to https://localhost:3000 (or another port if it says it started up the site on a different port)
+
+## Running using 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
From 9cc4f99e3db1d0011295e67399414bccf2229292 Mon Sep 17 00:00:00 2001
From: Benjamin Barbeau <73616169+Ategon@users.noreply.github.com>
Date: Thu, 16 Jan 2025 14:54:39 -0500
Subject: [PATCH 2/5] Update README.md
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index a6c85df..4b97736 100644
--- a/README.md
+++ b/README.md
@@ -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
From c74f207d1a6e6da79f3ed66206152f031f3d2dda Mon Sep 17 00:00:00 2001
From: Benjamin Barbeau <73616169+Ategon@users.noreply.github.com>
Date: Thu, 16 Jan 2025 14:55:47 -0500
Subject: [PATCH 3/5] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 4b97736..c77ba36 100644
--- a/README.md
+++ b/README.md
@@ -35,4 +35,4 @@ NEXT_PUBLIC_MODE=DEV
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
+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. This will need to be done after any changes you make to rebuilt the image
From 8002647ec7d0506ad63e0d4c085bc399b400b608 Mon Sep 17 00:00:00 2001
From: Benjamin Barbeau <73616169+Ategon@users.noreply.github.com>
Date: Thu, 16 Jan 2025 14:56:08 -0500
Subject: [PATCH 4/5] Update README.md
---
README.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/README.md b/README.md
index c77ba36..125f16a 100644
--- a/README.md
+++ b/README.md
@@ -35,4 +35,4 @@ NEXT_PUBLIC_MODE=DEV
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. This will need to be done after any changes you make to rebuilt the image
+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. This will need to be done after any changes you make to rebuild the image
From cef03390d43b6f16c6796c98ddaf07cd0472f49b Mon Sep 17 00:00:00 2001
From: boragenel <boragenel@gmail.com>
Date: Thu, 16 Jan 2025 23:24:24 +0300
Subject: [PATCH 5/5] updated github link to point https://github.com/Dare2Jam/
---
src/components/navbar/index.tsx | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/components/navbar/index.tsx b/src/components/navbar/index.tsx
index ee12809..51c0489 100644
--- a/src/components/navbar/index.tsx
+++ b/src/components/navbar/index.tsx
@@ -173,7 +173,7 @@ export default function Navbar() {
}
>
<Link
- href="https://github.com/Ategon/Jamjar"
+ href="https://github.com/Dare2Jam/"
className="text-white flex justify-center duration-500 ease-in-out transition-all transform hover:scale-125 hover:text-red-100"
isExternal
>
@@ -345,7 +345,7 @@ export default function Navbar() {
}
>
<Link
- href="https://github.com/Ategon/Jamjar"
+ href="https://github.com/Dare2Jam/"
className="text-white flex justify-center duration-500 ease-in-out transition-all transform hover:scale-125 hover:text-red-100"
isExternal
>