> ## Documentation Index > Fetch the complete documentation index at: https://docs.hackutd.co/llms.txt > Use this file to discover all available pages before exploring further. # Contributing > How to set up the Jury development environment and contribute First of all, thank you for your interest in contributing to Jury! This project would not be possible without open-source developers like you. Refer to the [Github Issues Page](https://github.com/hackutd/jury/issues) to find an issue you would like to work on. Once you find an issue you would like to work on, follow these steps: 0. Before starting with the issue, set up your development environment (see [below](#development-setup)) and get familiar with the repo (also read up on the [Technical Details](/jury/details/overview)) 1. Please comment on the issue and a moderator will assign you to the issue 2. Once you have been assigned an issue, fork the project and work on the issue assigned 3. Create a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) on Github to have your changes reviewed 4. Finally, merge your changes into the project! This page will go over how to set up the Jury development environment. Again, refer to the [Technical Details](/jury/details/overview) page for more information about the specifics of the application. ## Development setup **Only developing frontend?** If you are ONLY developing frontend, you will only need `yarn` and `node` to run the frontend. See the [section below](#only-running-frontend) for more information. The entire development environment is set up using [Docker Compose](https://docs.docker.com/compose/). You simply need to have Docker and Docker Compose [installed](https://docs.docker.com/compose/install/) to run the application -- no other system dependencies required! (Though it may be nice to have `node`/`go` installed for debugging in your IDE). ### With Docker (recommended!) Copy `.env.template` into `.env` and fill in the environmental variables (see [environmental variables](/jury/reference/envs) for more details). Once finished, all you have to do is run the following command to start up the dev server: ```bash theme={null} docker compose -f docker-compose.dev.yml up ``` This may take a while to download and build the first time but will be much faster on subsequent runs. You should see the following messages in the log when they are done: Frontend: ``` jury-dev-frontend | $ vite jury-dev-frontend | jury-dev-frontend | VITE v5.2.2 ready in 327 ms jury-dev-frontend | jury-dev-frontend | ➜ Local: http://localhost:3000/ jury-dev-frontend | ➜ Network: http://172.18.0.3:3000/ ``` Backend (will show ALL routes): ``` jury-dev-backend | [GIN-debug] POST /api/admin/categories --> server/router.SetCategories (7 handlers) jury-dev-backend | [GIN-debug] GET /api/categories --> server/router.GetCategories (7 handlers) jury-dev-backend | [GIN-debug] GET /favicon.ico --> github.com/gin-gonic/gin.(*RouterGroup).StaticFile.func1 (7 handlers) jury-dev-backend | [GIN-debug] HEAD /favicon.ico --> github.com/gin-gonic/gin.(*RouterGroup).StaticFile.func1 (7 handlers) ``` ### With Docker + local database If you don't want to create a MongoDB instance or don't want to work online, you can use the local database development runtime. Note that this only works offline if you've **downloaded the packages before** (ie. you need to run this with a connection at least once). Copy `.env.template` into `.env` and fill in the environmental variables (see [environmental variables](/jury/reference/envs) for more details). Instead of defining `MONGODB_URI`, you should define the following variables: ``` MONGODB_USER= MONGODB_PASS= ``` Note that the above fields can be anything you want, but changing the user/password will break the docker compose script (you will need to reset the database or manually change the username/password of the saved instance). Then, run the following command: ```bash theme={null} docker compose -f docker-compose-mongo.dev.yml up ``` As with above, you will need to wait for both the backend and frontend to load. Additionally, you will have to wait for the MongoDB database to initialize and create a replica set (takes more than 10 seconds). Make sure you don't define `MONGODB_URI` when using the local database. It will take precedence over the manual username/password definition! #### Connecting to the MongoDB container (running locally) This is only applicable if you used the `docker-compose-mongo.dev.yml` compose file. Use `mongodb://{MONGODB_USER}:{MONGODB_PASS}@0.0.0.0:27107/?directConnection=true` as the connection string. This works with both MongoDB Compass and through `mongosh`. To reset the database and reload the sample data, completely remove the `data` folder that the Docker compose creates. If you are using MongoDB Atlas, your connection string will be different. It is easier to see the data from the [MongoDB Atlas Console](https://cloud.mongodb.com/). MongoDB Atlas has connection instructions from `mongosh` [here](https://www.mongodb.com/docs/atlas/mongo-shell-connection/). ### Manual installation Although the easiest development environment is through docker compose, you can manually start the frontend and backend individually. Requirements: * [yarn](https://yarnpkg.com/) + [Node.js](https://nodejs.org/en) * [go](https://go.dev/) Copy `.env.template` into `.env` and fill in the environmental variables (same as above). Additionally, copy `client/.env.template` into `client/.env` and copy over the relevant environmental variables from `.env`. This is used to expose the correct environmental variables to the running instance of the Vite frontend as you will not have Docker compose to automatically do that for you. Client dev server (PORT 3000): ```bash theme={null} cd client yarn install yarn start ``` Backend dev server (PORT 8000): ```bash theme={null} go run . ``` ### Only running frontend If you wish to ONLY work on the frontend code, you may use the hosted staging app API as your backend, without having to run the Go backend server locally. To do this, go into the `client` folder and make a copy of `client/.env.template` to `client/.env`. You should have the following environmental variables set: ``` VITE_JURY_URL=https://jury-dev.mikz.dev/api VITE_JURY_NAME= ``` The `VITE_JURY_NAME` field can be anything; it'll be used as the name of the hackathon displayed, but make sure to have the `VITE_JURY_URL` set correctly! Once you have that setup, from the `client` folder run the following commands: ```bash theme={null} yarn install yarn start ``` **Troubleshooting** If you get the following warning: `error Error: EACCES: permission denied, unlink '<...>/jury/client/node_modules/.yarn-integrity'`, you will need to first remove the `node_modules` folder. Most likely you have run the docker instance before trying this. Docker will transfer ownership of the `node_modules` folder to itself. However, you can simply remove the folder to fix the issue (do `sudo rm -rf node_modules` on UNIX systems). ## Testing A comprehensive framework for testing the backend is contained within the `tests` folder. Make sure you have your environmental variables defined as above. One extra environmental variable you can define is `LOG_LEVEL`, which defines what to output from the tests. The default level is `info`, but you can specify one of the following levels, in order of increasing verboseness: * error * warn * info * verbose To perform the tests, simply run the following: ```bash theme={null} docker compose -f docker-compose.test.yml up ``` This should run through all the tests and output results to `tests/test-log.txt`. ## Other resources ### Design file Here is the Figma design file: [https://www.figma.com/file/qwBWs4i7pJMpFbcjMffDZU/Jury-(Gavel-Plus)?node-id=8%3A100\&t=xYwfPwRAUeJw9jNr-1](https://www.figma.com/file/qwBWs4i7pJMpFbcjMffDZU/Jury-\(Gavel-Plus\)?node-id=8%3A100\&t=xYwfPwRAUeJw9jNr-1) ### Technical details Keep reading on for the [Technical Details](/jury/details/overview).