Skip to content

Commit 29d6e69

Browse files
Merge pull request #222 from ComputerScienceHouse/wdn/alumn
update dev environment setup instructions
2 parents 4f0c918 + 0f54e62 commit 29d6e69

File tree

3 files changed

+11
-22
lines changed

3 files changed

+11
-22
lines changed

HACKING/README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,25 +22,26 @@ source venv/bin/activate
2222

2323
### Podman Environment Instructions
2424

25-
1. Build your containers. The `proxstar` container serves as proxstar, rq, rq-scheduler, and VNC. The `proxstar-postgres` container sets up the database schema.
25+
1. Copy `.env.template` to `.env` and fill it out with the help of an RTP
2626

27-
`mkdir HACKING/proxstar-postgres/volume`
28-
29-
`podman build . --tag=proxstar`
27+
2. Create volume for postgres
3028

31-
`podman build HACKING/proxstar-postgres --tag=proxstar-postgres`
29+
`mkdir HACKING/proxstar-postgres/volume`
3230

33-
2. Configure your environment variables. I'd recommend setting up a .env file and passing that into your container. Check `.env.template` for more info.
31+
3. Build the proxstar container and launch it on your system.
3432

35-
3. Run it. This sets up redis, postgres, rq, and proxstar.
33+
`podman compose up -d`
3634

37-
`./HACKING/launch_env.sh`
35+
To access the proxstar WebUI, go to https://localhost:8000
3836

3937
4. To stop all containers, use the provided script
4038

41-
`./HACKING/stop_env.sh`
39+
`podman compose down`
40+
41+
## Setting up a full dev environment (Advanced)
4242

43-
## Setting up a full dev environment
43+
> [!INFO]
44+
> This is not required for most contributors
4445
4546
If you want to work on Proxstar using a 1:1 development setup, there are a couple things you're going to need
4647

HACKING/launch_env.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.

HACKING/stop_env.sh

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)