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
Frontend for a jam site
119 commits 1 branch 0 tags 4.9 MiB
TypeScript 99.7%
CSS 0.2%
Find a file
Ategon b3cc66078a Remove underline abilities
2025-02-11 12:38:24 -05:00
public/images Add image to editor menu 2025-02-11 02:17:57 -05:00
src Remove underline abilities 2025-02-11 12:38:24 -05:00
.dockerignore Add docker support 2025-01-15 14:05:38 -05:00
.eslintrc.json Initial commit from Create Next App 2024-10-22 20:54:44 -04:00
.gitignore Initial commit from Create Next App 2024-10-22 20:54:44 -04:00
docker-compose.yml Adjust ports 2025-01-15 16:35:21 -05:00
Dockerfile Add docker support 2025-01-15 14:05:38 -05:00
LICENSE Add license 2025-01-14 17:22:56 -05:00
next.config.ts Add image uploads 2025-02-10 18:25:42 -05:00
package-lock.json Remove underline abilities 2025-02-11 12:38:24 -05:00
package.json Remove underline abilities 2025-02-11 12:38:24 -05:00
postcss.config.mjs Initial commit from Create Next App 2024-10-22 20:54:44 -04:00
README.md Update README.md 2025-01-16 14:56:08 -05:00
tailwind.config.ts Light theme and wysiwyg 2025-01-19 13:38:18 -05:00
tsconfig.json Initial commit from Create Next App 2024-10-22 20:54:44 -04:00

README.md

Jamjar

Frontend for a game jam site

Things used

  • 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)
  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)
NEXT_PUBLIC_MODE=DEV
  1. 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)
  2. 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