Skip to content
This repository has been archived by the owner on May 1, 2021. It is now read-only.

UPDATE the Docs in README.md and create CONTRIBUTING.md #13

Open
wants to merge 9 commits into
base: staging
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .whitesource
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"scanSettings": {
"baseBranches": []
},
"checkRunSettings": {
"vulnerableCheckRunConclusionLevel": "failure",
"displayMode": "diff"
},
"issueSettings": {
"minSeverityLevel": "LOW"
}
}
Empty file added CONTRIBUTING.md
Empty file.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
</p>

<h3 align="center">
<a href="CONTRIBUTING.md">Contribute (soon)</a>
<a href="CONTRIBUTING.md">Contribute</a>
<span> · </span>
<a href="https://discord.gg/Nu6KVjJYj6">Discord</a>
<span> · </span>
<a href="https://docs.dogehouse.xyz">Documentation (soon)</a>
<a href="https://wiki.dogehouse.xyz">Documentation</a>
</h3>

---
Expand All @@ -30,7 +30,7 @@
1. Clone repository using by running `$ git clone https://github.com/dogegarden/dogehouse-site/` in your terminal
2. Navigate into the directory
3. Install NodeJS and NPM
4. Run `$ npm i` to install the required package's
4. Run `$ npm i` to install the required packages
5. Setup .env file
6. Execute the command `$ npm run dev` in your terminal

Expand Down Expand Up @@ -62,3 +62,6 @@ DOGEHOUSE_WSS=wss://api.dogehouse.tv/socket - socket url for main dogehouse serv
REDIS_HOST=REDDIS HOST - setup reddis with host and pass
REDIS_PASS=REDDIS PASS - setup reddis with host and pass
```

## Credits
Thank you to Abalon#2525/https://github.com/alon-abadi for the awesome logo!
4 changes: 2 additions & 2 deletions src/views/index.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
<p>You can <a href="/panel">click here</a> to visit the panel.</p>
<% } else { %>
<h1>DogeHouse.xyz</h1>
<p><i>Welcome to DogeHotel/DogeGarden<br><br>need slogon.</i></p><br>
<p><i>Welcome to DogeHotel/DogeGarden<br><br>Needs slogan.</i></p><br>
<% } %>
</div>
</body>

</html>
</html>