From 189a20b9eb3bdcf6f60c0a4981e3eb138d1b37c0 Mon Sep 17 00:00:00 2001 From: Luis-Hebendanz Date: Tue, 31 Oct 2023 21:12:55 +0100 Subject: [PATCH 1/4] Test change --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 5a6f835..2a3e2dd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # Website Template + Welcome to our website template repository! This template is designed to help you and your team build high-quality websites efficiently. We've carefully chosen the technologies to make development smooth and enjoyable. Here's what you can expect from this template: **Frontend**: Our frontend is powered by [React NextJS](https://nextjs.org/), a popular and versatile framework for building web applications. -- 2.51.0 From 22d39dff271e7484c2f56b2a60c7dc78b17d09da Mon Sep 17 00:00:00 2001 From: Luis-Hebendanz Date: Tue, 31 Oct 2023 21:13:33 +0100 Subject: [PATCH 2/4] Test change --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 2a3e2dd..d95f4b7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,5 @@ # Website Template - Welcome to our website template repository! This template is designed to help you and your team build high-quality websites efficiently. We've carefully chosen the technologies to make development smooth and enjoyable. Here's what you can expect from this template: **Frontend**: Our frontend is powered by [React NextJS](https://nextjs.org/), a popular and versatile framework for building web applications. @@ -195,4 +194,4 @@ To make the most of this template: - Set the option to "Delete pull request branch after merge by default." - Also, set the default merge style to "Rebase then create merge commit." -With this template, you're well-equipped to build and collaborate on high-quality websites efficiently. Happy coding! +With this template, you're well-equipped to build and collaborate on high-quality websites efficiently. Happy coding!. -- 2.51.0 From add7686ebc8cfd543d9e86eaba9bce76dde6bfa8 Mon Sep 17 00:00:00 2001 From: Luis-Hebendanz Date: Wed, 1 Nov 2023 15:57:51 +0100 Subject: [PATCH 3/4] Fixed missing direnv install step in README --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d95f4b7..a07da0d 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,10 @@ Welcome to our website template repository! This template is designed to help yo **Dependency Management**: We use the [Nix package manager](https://nixos.org/) to manage dependencies and ensure reproducibility, making your development process more robust. +## Supported Operating Systems +- Linux +- macOS + # Getting Started with the Development Environment Let's get your development environment up and running: @@ -28,11 +32,18 @@ Let's get your development environment up and running: curl -sfL https://direnv.net/install.sh | bash ``` -3. **Clone the Repository and Navigate**: +3. **Add direnv to your shell**: + - Direnv needs to [hook into your shell](https://direnv.net/docs/hook.html) to work. + You can do this by executing following command: + ```bash + echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc && echo 'eval "$(direnv hook bash)"' >> ~/.bashrc && eval "$SHELL" + ``` + +4. **Clone the Repository and Navigate**: - Clone this repository and navigate to it. -4. **Allow .envrc**: +5. **Allow .envrc**: - When you enter the directory, you'll receive an error message like this: ```bash @@ -40,7 +51,7 @@ Let's get your development environment up and running: ``` - Execute `direnv allow` to automatically execute the shell script `.envrc` when entering the directory. -5. **Build the Backend**: +6. **Build the Backend**: - Go to the `pkgs/clan-cli` directory and execute: ```bash @@ -48,7 +59,7 @@ Let's get your development environment up and running: ``` - Wait for the backend to build. -6. **Start the Backend Server**: +7. **Start the Backend Server**: - To start the backend server, execute: ```bash @@ -56,7 +67,7 @@ Let's get your development environment up and running: ``` - The server will automatically restart if any Python files change. -7. **Build the Frontend**: +8. **Build the Frontend**: - In a different shell, navigate to the `pkgs/ui` directory and execute: ```bash @@ -64,7 +75,7 @@ Let's get your development environment up and running: ``` - Wait for the frontend to build. -8. **Start the Frontend**: +9. **Start the Frontend**: - To start the frontend, execute: ```bash npm run dev -- 2.51.0 From 830211fc36275dbb69854a43e907e64d86206fb9 Mon Sep 17 00:00:00 2001 From: Luis-Hebendanz Date: Wed, 1 Nov 2023 15:58:18 +0100 Subject: [PATCH 4/4] nix fmt --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a07da0d..ba0a1ec 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,7 @@ Welcome to our website template repository! This template is designed to help yo **Dependency Management**: We use the [Nix package manager](https://nixos.org/) to manage dependencies and ensure reproducibility, making your development process more robust. ## Supported Operating Systems + - Linux - macOS @@ -33,8 +34,10 @@ Let's get your development environment up and running: ``` 3. **Add direnv to your shell**: + - Direnv needs to [hook into your shell](https://direnv.net/docs/hook.html) to work. - You can do this by executing following command: + You can do this by executing following command: + ```bash echo 'eval "$(direnv hook zsh)"' >> ~/.zshrc && echo 'eval "$(direnv hook bash)"' >> ~/.bashrc && eval "$SHELL" ``` -- 2.51.0