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:50:50 -05:00 committed by GitHub
parent 4642ea9032
commit c1693a3166
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 19 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -2,15 +2,27 @@
Frontend for a game jam site Frontend for a game jam site
To run using next.js (for development) ## Things used
``` - Typescript (language)
npm i - Next.js (web framework)
npm run dev - 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