Deuxfleurs/guichet
18
4
Fork 4
Code Issues 43 Pull requests 3 Projects 2 Releases Wiki Activity

Add instructions about how to run Guichet locally #81

Merged
quentin merged 8 commits from fabientot/guichet:improve-local-development into main 2025-03-24 15:41:29 +00:00
Conversation 2 Commits 8 Files changed 1 +61 -2
fabientot commented 2025-03-20 22:24:50 +00:00
Member
Copy link

Some instructions are missing to run Guichet locally without Garage / Bottin knowledge.
I tried to keep this as simple as possible :

  • add a few docker compose commands to get up & running with Garage
  • migrate instructions nested in integration/README.md into the main README

For now I have no touched to the docker-compose.yml, I created on in the first place but decided to keep it as is, as it worked well during my work.

A few questions / suggestions :

  • Should we keep the README in integration directory ? It is written in French at the moment and might bring some confusion at some point as its content overlaps my current updates
  • Why put the docker-compose in a subdirectory ? It confused me at first, as I did not find it and started re-creating one. It seems (to me) a common practice is to have it at the repo's root.
Some instructions are missing to run Guichet locally without Garage / Bottin knowledge. I tried to keep this as simple as possible : - add a few `docker compose` commands to get up & running with Garage - migrate instructions nested in `integration/README.md` into the main README - For now I have no touched to the `docker-compose.yml`, I created on in the first place but decided to keep it as is, as it worked well during my work. **A few questions / suggestions :** - Should we keep the README in `integration` directory ? It is written in French at the moment and might bring some confusion at some point as its content overlaps my current updates - Why put the `docker-compose` in a subdirectory ? It confused me at first, as I did not find it and started re-creating one. It seems (to me) a common practice is to have it at the repo's root.
fabientot added 1 commit 2025-03-20 22:24:50 +00:00
Improve developper experience
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
bda9be9807 
- Add docker compose
- Fix a few typo in README
- Add steps to run project locally
- Add a sample bottin config
fabientot force-pushed improve-local-development from bda9be9807 to 48df2123cf 2025-03-20 22:28:07 +00:00 Compare
fabientot added 1 commit 2025-03-20 22:29:12 +00:00
Do not expose ports in consul
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
4f3b5d8210
fabientot added 1 commit 2025-03-23 19:11:20 +00:00
Update readme
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
0d3457142e
fabientot changed title from [WIP] Improve developper experience to Add instructions about how to run Guichet locally 2025-03-23 19:24:54 +00:00
fabientot added 1 commit 2025-03-23 19:31:31 +00:00
Add garage in list
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
a7180549ed
fabientot added 1 commit 2025-03-23 19:33:00 +00:00
Typo + link
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
9fef8d855f
fabientot added 1 commit 2025-03-23 19:35:15 +00:00
Update comments
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
56d78d4a1f
fabientot added 1 commit 2025-03-23 19:36:35 +00:00
Add password example
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
df7c2e973e
fabientot force-pushed improve-local-development from df7c2e973e to 97a0d1ed24 2025-03-23 19:38:08 +00:00 Compare
fabientot added 1 commit 2025-03-23 19:38:43 +00:00
Merge branch 'main' into improve-local-development
Some checks are pending
ci/woodpecker/pr/woodpecker Pipeline is pending approval
Details
b2a577d6f2
fabientot force-pushed improve-local-development from b2a577d6f2 to c1fcc1bbba 2025-03-23 19:39:44 +00:00 Compare
quentin commented 2025-03-24 15:36:54 +00:00
Owner
Copy link

Why put the docker-compose in a subdirectory ? It confused me at first, as I did not find it and started re-creating one. It seems (to me) a common practice is to have it at the repo's root.

It's a pattern we use on the nixcfg repo, as we have a docker-compose.yml for building dockerfiles that is different from the one used for integration testing. In this case, as long as we have a single compose file, we can move it as compose.yaml at the project root.

Should we keep the README in integration directory ? It is written in French at the moment and might bring some confusion at some point as its content overlaps my current updates

We can drop the README if we put the compose file at the project root, and especially as you put the instructions in english at the project root. For now, Guichet interface is hardcoded in french, so writing in french or english is not that important. But now that Guichet might be a critical project, and internationalizing it is something we can envision in the future, switching to english for this project might be great.

> Why put the docker-compose in a subdirectory ? It confused me at first, as I did not find it and started re-creating one. It seems (to me) a common practice is to have it at the repo's root. It's a pattern we use on the `nixcfg` repo, as we have a docker-compose.yml for building dockerfiles that is different from the one used for integration testing. In this case, as long as we have a single compose file, we can move it as `compose.yaml` at the project root. > Should we keep the README in integration directory ? It is written in French at the moment and might bring some confusion at some point as its content overlaps my current updates We can drop the README if we put the compose file at the project root, and especially as you put the instructions in english at the project root. For now, Guichet interface is hardcoded in french, so writing in french or english is not that important. But now that Guichet might be a critical project, and internationalizing it is something we can envision in the future, switching to english for this project might be great.
quentin commented 2025-03-24 15:41:21 +00:00
Owner
Copy link

I will merge this PR, can you create another PR where you move the compose file at the root of the project + update the README? Thanks in advance.

I will merge this PR, can you create another PR where you move the compose file at the root of the project + update the README? Thanks in advance.
quentin merged commit 492be02f59 into main 2025-03-24 15:41:29 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
cat
bug

  
cat
feature

  
cat
idea

  
cat
performance

  
cat
reliability

  
cat
security

  
cat
ui

  
difficulty
high

  
difficulty
low

  
difficulty
mid

  
prio
high

  
prio
low

  
prio
mid

No labels
cat
bug
cat
feature
cat
idea
cat
performance
cat
reliability
cat
security
cat
ui
difficulty
high
difficulty
low
difficulty
mid
prio
high
prio
low
prio
mid
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: Deuxfleurs/guichet#81
No description provided.
Delete branch "fabientot/guichet:improve-local-development"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?