Merge branch 'main' of https://github.com/Edikoyo-Jam/Jamjar

README.md

@@ -2,15 +2,37 @@
 
 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)
+- Lucide (icons)
+- Eslint (static code analysis)
+- Framer motion (animations)
+- React Toastify (toasts)
 
-To run using docker and docker compose
+## 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)
+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
+
+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 rebuild the image

src/components/navbar/index.tsx

@@ -275,7 +275,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
                 >
@@ -447,7 +447,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
             >