From 1d06f8807f336c63d559e0840b518633a7877166 Mon Sep 17 00:00:00 2001 From: thonk <101288516+VillainsRule@users.noreply.github.com> Date: Sat, 7 Oct 2023 20:56:54 -0400 Subject: [PATCH] improve readme --- README.md | 54 ++++++++++++++++++++++++------------------------------ 1 file changed, 24 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 1fd61cb..39d2a7c 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,28 @@
- -

Polaris

-

The future of school gaming.

+ +

Polaris

+

the next generation site for school gaming.

+ + ![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) + +
+

Quick Web Deployment

+ +[![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) + +
+

Terminal Deployment

-
+> [!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!