Compare commits

..

5 Commits

Author SHA1 Message Date
109fb6c1c5 nix fmt
All checks were successful
checks / test (pull_request) Successful in 1m29s
checks-impure / test (pull_request) Successful in 26s
2023-10-31 12:28:42 +01:00
a3b85fab4d Improved README 2023-10-31 12:28:15 +01:00
8a2c3517f5 Fixed missing gnused in ui-assets.sh
All checks were successful
checks-impure / test (pull_request) Successful in 24s
checks / test (pull_request) Successful in 1m31s
2023-10-30 17:32:01 +01:00
a21028aa65 Generate ui assets package_name on the fly
All checks were successful
checks-impure / test (pull_request) Successful in 24s
checks / test (pull_request) Successful in 2m47s
2023-10-30 17:21:44 +01:00
242dbeb253 nix fmt 2023-10-30 17:14:15 +01:00
3 changed files with 10 additions and 24 deletions

View File

@@ -10,11 +10,6 @@ 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. **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 # Getting Started with the Development Environment
Let's get your development environment up and running: Let's get your development environment up and running:
@@ -33,20 +28,11 @@ Let's get your development environment up and running:
curl -sfL https://direnv.net/install.sh | bash curl -sfL https://direnv.net/install.sh | bash
``` ```
3. **Add direnv to your shell**: 3. **Clone the Repository and Navigate**:
- 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. - Clone this repository and navigate to it.
5. **Allow .envrc**: 4. **Allow .envrc**:
- When you enter the directory, you'll receive an error message like this: - When you enter the directory, you'll receive an error message like this:
```bash ```bash
@@ -54,7 +40,7 @@ Let's get your development environment up and running:
``` ```
- Execute `direnv allow` to automatically execute the shell script `.envrc` when entering the directory. - Execute `direnv allow` to automatically execute the shell script `.envrc` when entering the directory.
6. **Build the Backend**: 5. **Build the Backend**:
- Go to the `pkgs/clan-cli` directory and execute: - Go to the `pkgs/clan-cli` directory and execute:
```bash ```bash
@@ -62,7 +48,7 @@ Let's get your development environment up and running:
``` ```
- Wait for the backend to build. - Wait for the backend to build.
7. **Start the Backend Server**: 6. **Start the Backend Server**:
- To start the backend server, execute: - To start the backend server, execute:
```bash ```bash
@@ -70,7 +56,7 @@ Let's get your development environment up and running:
``` ```
- The server will automatically restart if any Python files change. - The server will automatically restart if any Python files change.
8. **Build the Frontend**: 7. **Build the Frontend**:
- In a different shell, navigate to the `pkgs/ui` directory and execute: - In a different shell, navigate to the `pkgs/ui` directory and execute:
```bash ```bash
@@ -78,7 +64,7 @@ Let's get your development environment up and running:
``` ```
- Wait for the frontend to build. - Wait for the frontend to build.
9. **Start the Frontend**: 8. **Start the Frontend**:
- To start the frontend, execute: - To start the frontend, execute:
```bash ```bash
npm run dev npm run dev
@@ -208,4 +194,4 @@ To make the most of this template:
- Set the option to "Delete pull request branch after merge by default." - Set the option to "Delete pull request branch after merge by default."
- Also, set the default merge style to "Rebase then create merge commit." - 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!

View File

@@ -1,5 +1,5 @@
{ fetchzip }: { fetchzip }:
fetchzip { fetchzip {
url = "https://gitea.gchq.icu/api/packages/ui-asset-bot/generic/Luis-nextjs-python-web-template/0wq3lxsnsr9jcjqfhmxvjzxr4zz46aimwj1m23n7zzc835b47d70/assets.tar.gz"; url = "https://gitea.gchq.icu/api/packages/ui-asset-bot/generic/ui/1inlxk1i9q87bw00zwqyvpm3m0hdgdffhxlymzgi5wvqn9syd0cm/assets.tar.gz";
sha256 = "0wq3lxsnsr9jcjqfhmxvjzxr4zz46aimwj1m23n7zzc835b47d70"; sha256 = "1inlxk1i9q87bw00zwqyvpm3m0hdgdffhxlymzgi5wvqn9syd0cm";
} }

View File

@@ -25,7 +25,7 @@ pkgs.mkShell {
# re-generate the api code # re-generate the api code
rm -rf src/api openapi.json rm -rf api openapi.json
cp ${clanPkgs.clan-openapi}/openapi.json . cp ${clanPkgs.clan-openapi}/openapi.json .
orval orval
''; '';