README.md (1823B)
1 # Draupnir4All Admin 2 3 Draupnir4All Admin is a private project designed to manage and administer Draupnirs which are provisioned by the Appservice mode. 4 5 ## Prerequisites 6 7 Before you begin, ensure you have the following installed on your system: 8 9 - [Node.js](https://nodejs.org/) (version 18.18.0 or higher is recommended) 10 - [pnpm](https://pnpm.io/) (a fast, disk space-efficient package manager) 11 12 ## Installation 13 14 To get started, clone the repository and install the dependencies using `pnpm`: 15 16 ```bash 17 git clone https://github.com/MTRNord/draupnir4all-web.git 18 cd draupnir4all-web 19 pnpm install 20 ``` 21 22 ## Scripts 23 24 The project includes several scripts defined in the `package.json` file. You can run these scripts using `pnpm`: 25 26 - **Development**: Start the development server with Turbopack. 27 28 ```bash 29 pnpm dev 30 ``` 31 32 - **Build**: Build the project for production. 33 34 ```bash 35 pnpm build 36 ``` 37 38 - **Start**: Start the production server. 39 40 ```bash 41 pnpm start 42 ``` 43 44 - **Lint**: Run linting checks using Next.js. 45 46 ```bash 47 pnpm lint 48 ``` 49 50 ## Usage 51 52 1. Run the development server: 53 54 ```bash 55 pnpm dev 56 ``` 57 58 This will start the application in development mode. You can access it at `http://localhost:3000`. 59 60 2. To build the project for production: 61 62 ```bash 63 pnpm build 64 ``` 65 66 3. Start the production server: 67 68 ```bash 69 pnpm start 70 ``` 71 72 4. Use the linting script to ensure code quality: 73 74 ```bash 75 pnpm lint 76 ``` 77 78 ## Package Manager 79 80 This project uses `pnpm` as the package manager. It is faster and more efficient than traditional package managers like npm or yarn. If you don't have `pnpm` installed, you can install it globally using npm: 81 82 ```bash 83 npm install -g pnpm 84 ``` 85 86 ## License 87 88 This project is licensed under the Apache-2.0 License. See the [LICENSE](LICENSE) file for more details.