aheh/Polaris
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve readme

Browse Source
This commit is contained in:
thonk
2023-10-07 20:56:54 -04:00
committed by GitHub
parent 477b88fa2c
commit 1d06f8807f
1 changed files with 24 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+24 -30
View File
@@ -1,34 +1,28 @@
<div align="center">
<img src="https://raw.githubusercontent.com/polarisdevs/polaris-V1/main/static/assets/img/polaris.png" width="190px">
<h1 align="center">Polaris</h1>
<p>The future of school gaming.</p>
<img src="./static/android-chrome-512x512.png" width="300px">
<h1>Polaris</h1>
<p>the next generation site for school gaming.</p>
![Discord](https://img.shields.io/discord/950407933408198717?label=Discord&style=for-the-badge)
![Commit activity](https://img.shields.io/github/commit-activity/w/Skoolgq/v2?style=for-the-badge)
<br>
<h2>Quick Web Deployment</h2>
[![Run on Replit](https://binbashbanana.github.io/deploy-buttons/buttons/remade/replit.svg)](https://replit.com/github/Skoolgq/Polaris)
[![Deploy to Vercel](https://binbashbanana.github.io/deploy-buttons/buttons/remade/vercel.svg)](https://vercel.com/new/clone?repository-url=https://github.com/Skoolgq/Polaris)
[![Deploy to Koyeb](https://binbashbanana.github.io/deploy-buttons/buttons/remade/koyeb.svg)](https://app.koyeb.com/deploy?type=git&repository=github.com/Skoolgq/Polaris&branch=main&name=Polaris)
[![Deploy to Render](https://binbashbanana.github.io/deploy-buttons/buttons/remade/render.svg)](https://render.com/deploy?repo=https://github.com/Skoolgq/Polaris)
[![Deploy to Cyclic](https://binbashbanana.github.io/deploy-buttons/buttons/remade/cyclic.svg)](https://app.cyclic.sh/api/app/deploy/Skoolgq/Polaris)
<br>
<h2>Terminal Deployment</h2>
</div>
<br>
> [!NOTE]
> We require a NodeJS version >=18.
## Terminal Deployment
> **Note:**
> We require NodeJS V18 or higher
### Steps
1. Clone the repo
```bash
git clone https://github.com/Skoolgq/Polaris.git
```
2. Enter the directory
```bash
cd Polaris
```
3. Install Dependencies
```bash
npm install
```
4. Run it!
```bash
npm start
```
5. Visit [localhost:8080](http://localhost:8080) for your local Polaris!
1. Clone the repo to your machine: `git clone https://github.com/Skoolgq/Polaris.git && cd Polaris`
2. Install Dependencies: `npm install`
3. Start the app: `npm start`
4. Visit [localhost:8080](http://localhost:8080) for your local Polaris!