yeetus

2023-05-10 12:17:23 -04:00
parent 0630d58fc5
commit f5418a662c
1 changed files with 28 additions and 2 deletions
@@ -1,2 +1,28 @@
-# Polaris
-feel free to use our code just dont redeploy the site without changing anything
+<p align="center">
+  <img src="https://raw.githubusercontent.com/polarisdevs/polaris-V1/main/static/assets/img/polaris.png" width="190px"/>
+</p>
+<h1 align="center">Polaris</h1>
+The future of school gaming.
+
+## Terminal Deployment
+### Prerequisites
+We require NodeJS v18 and higher.<br>
+
+### Steps
+1. Cloning
+````bash
+git clone https://github.com/polarisdevs/polaris-V1.git
+cd polaris-V1
+````
+
+2. Installing
+```bash
+npm install
+```
+
+3. Run it!
+```bash
+npm start
+```
+
+4. Visit [localhost:8080](http://localhost:8080) for your site.