Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 2.01 KB

DEVELOPMENT.md

File metadata and controls

55 lines (33 loc) · 2.01 KB
Raw

Development setup for Secret Hitler Online

Your setup will vary depending on if you're only making changes to the frontend, or if you're making changes to the frontend and the backend at once.

Frontend Only

Follow these instructions if you are only making changes to the frontend. These instructions will allow you to connect to the development server rather than needing to run the instance locally.

Running frontend server

Open a terminal window and run the following commands to clone the project and set up the frontend dependencies:

git clone [email protected]:ShrimpCryptid/Secret-Hitler-Online.git
cd Secret-Hitler-Online/frontend

npm install
npm run devServer

The webpage should open automatically in your browser, but is usually hosted at localhost:3000.

Changing frontend + backend

If you're modifying the backend, you'll need to run the server locally. You'll need two terminal windows to run the frontend and backend.

Running backend server

In your first terminal, clone the repo if you haven't yet. Navigate to the backend subdirectory, then use gradle to start the server.

git clone [email protected]:ShrimpCryptid/Secret-Hitler-Online.git
cd Secret-Hitler-Online/backend

./gradlew runLocal

This will start the backend server at http://localhost:4040 by default. This will also set the server in debug-mode, so the CORS policy will not block access from the frontend.

Every time you make changes to Java files, you'll need to stop and restart the development server.

You can also run the backend-server using your preferred IDE by launching the Main-method in ApplicationTest found in the test directory.

Running frontend server

Open another terminal at the root of the project, and run the following commands.

cd frontend

npm install
npm run devLocal

Note: You may need to modify .env.local based on the address your dev server is mounted to. By default, .env.local is configured to use localhost:4040.