aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorHampusM <hampus@hampusmat.com>2021-06-05 19:37:52 +0200
committerHampusM <hampus@hampusmat.com>2021-06-05 19:37:52 +0200
commit4da3272bf7893760f6710c9a1ec7de02358136e6 (patch)
tree92eb961bf20a7ef9f7c0650ba288baf512986fca /README.md
parent4e3074dfd752dd52951d300090c642aee76cfaac (diff)
Reorganized into a monorepo, refactored the frontend again, goodbye Parcel
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.md b/README.md
index 4210470..ad8ce75 100644
--- a/README.md
+++ b/README.md
@@ -32,31 +32,33 @@ Githermit will probably **never** be as fast as cgit, Gitweb & Stagit. But that'
- Git (obviously)
- Nodejs v14.16.0
-Install all the dependencies
+**Install all the dependencies**
-`$ npm install`
+`$ yarn install`
Build & bundle the frontend
-`$ npm run build`
+`$ yarn build`
Create a file called `settings.yml` with following content
```
-host: (host address)
-port: (port)
-title: (title of your Githermit instance)
-about: (short description of your Githermit instance)
-base_dir: (directory where all of your bare Git repositories are located)
+host: (Host address)
+port: (Port)
+dev_port: (Port for development server)
+production: (Set this to true unless you're doing changes to Githermit)
+title: (Title of your Githermit instance)
+about: (Short description of your Githermit instance)
+base_dir: (Directory where all of your bare Git repositories are located)
```
You can now run it with
-`$ npm start`
+`$ yarn start`
# Development
You're highly encouraged to [create a merge request](https://gitlab.com/HampusMat/githermit/-/merge_requests/new) if you're willing to contribute.
You can run the following command to easily get started with contributing
-`$ npm run dev`
+`$ yarn dev`
This will run an instance of Githermit with live-updating backend & frontend. \ No newline at end of file