From 250cf0c05aead1fa42988a3d0da2039f3069f405 Mon Sep 17 00:00:00 2001 From: Jerry Zhang Date: Tue, 1 Oct 2024 23:21:01 -0400 Subject: [PATCH] Update README.md --- README.md | 107 +++++++++++++++--------------------------------------- 1 file changed, 30 insertions(+), 77 deletions(-) diff --git a/README.md b/README.md index 9974f0c..b476d16 100644 --- a/README.md +++ b/README.md @@ -1,90 +1,43 @@ - - Next.js and Supabase Starter Kit - the fastest way to build apps with Next.js and Supabase -

Next.js and Supabase Starter Kit

- +# Electrium Mobility Shop -

- The fastest way to build apps with Next.js and Supabase -

+Repository for the Electrium Shop project. -

- Features · - Demo · - Deploy to Vercel · - Clone and run locally · - Feedback and issues - More Examples -

-
+*Kanban board*: Visit the Kanban board for Electrium Shop on [Clickup](https://app.clickup.com/9003010024/v/li/901104924034) -## Features +# Setup -- Works across the entire [Next.js](https://nextjs.org) stack - - App Router - - Pages Router - - Middleware - - Client - - Server - - It just works! -- supabase-ssr. A package to configure Supabase Auth to use cookies -- Styling with [Tailwind CSS](https://tailwindcss.com) -- Optional deployment with [Supabase Vercel Integration and Vercel deploy](#deploy-your-own) - - Environment variables automatically assigned to Vercel project +## Prerequisites -## Demo +Install everything in this list before moving on to the next step! +Required: +* [Git](https://git-scm.com/downloads) +* [Node.js](https://nodejs.org/en/download/package-manager) +* [VS Code](https://code.visualstudio.com/download) +* [GitHub Desktop](https://desktop.github.com/download/) Note: This is the recommended tool for pushing your commit on GitHub. -You can view a fully working demo at [demo-nextjs-with-supabase.vercel.app](https://demo-nextjs-with-supabase.vercel.app/). +**BONUS**: Have you ever considered signing up for the [GitHub Developer Pack](https://education.github.com/pack)? Check it out here! -## Deploy to Vercel +## Setting up your local environment +1. Clone the repository on your IDE: + ``` + git clone https://github.com/Electrium-Mobility/Electrium-store.git + ``` +2. Download the `.env` file from our Discord server's `config-and-credentials` channel under webdev and place it into the root folder of your repo -Vercel deployment will guide you through creating a Supabase account and project. +3. Run the following commands in your IDE: + ``` + npm i + ``` + (i is a shortcut for install) -After installation of the Supabase integration, all relevant environment variables will be assigned to the project so the deployment is fully functioning. + ``` + npm run build + ``` -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&project-name=nextjs-with-supabase&repository-name=nextjs-with-supabase&demo-title=nextjs-with-supabase&demo-description=This%20starter%20configures%20Supabase%20Auth%20to%20use%20cookies%2C%20making%20the%20user's%20session%20available%20throughout%20the%20entire%20Next.js%20app%20-%20Client%20Components%2C%20Server%20Components%2C%20Route%20Handlers%2C%20Server%20Actions%20and%20Middleware.&demo-url=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2F&external-id=https%3A%2F%2Fgithub.com%2Fvercel%2Fnext.js%2Ftree%2Fcanary%2Fexamples%2Fwith-supabase&demo-image=https%3A%2F%2Fdemo-nextjs-with-supabase.vercel.app%2Fopengraph-image.png&integration-ids=oac_VqOgBHqhEoFTPzGkPd7L0iH6) - -The above will also clone the Starter kit to your GitHub, you can clone that locally and develop locally. - -If you wish to just develop locally and not deploy to Vercel, [follow the steps below](#clone-and-run-locally). - -## Clone and run locally - -1. You'll first need a Supabase project which can be made [via the Supabase dashboard](https://database.new) - -2. Create a Next.js app using the Supabase Starter template npx command - - ```bash - npx create-next-app -e with-supabase - ``` - -3. Use `cd` to change into the app's directory - - ```bash - cd name-of-new-app - ``` - -4. Rename `.env.local.example` to `.env.local` and update the following: - - ``` - NEXT_PUBLIC_SUPABASE_URL=[INSERT SUPABASE PROJECT URL] - NEXT_PUBLIC_SUPABASE_ANON_KEY=[INSERT SUPABASE PROJECT API ANON KEY] - ``` - - Both `NEXT_PUBLIC_SUPABASE_URL` and `NEXT_PUBLIC_SUPABASE_ANON_KEY` can be found in [your Supabase project's API settings](https://app.supabase.com/project/_/settings/api) - -5. You can now run the Next.js local development server: - - ```bash - npm run dev - ``` - - The starter kit should now be running on [localhost:3000](http://localhost:3000/). - -> Check out [the docs for Local Development](https://supabase.com/docs/guides/getting-started/local-development) to also run Supabase locally. - -## Feedback and issues - -Please file feedback and issues over on the [Supabase GitHub org](https://github.com/supabase/supabase/issues/new/choose). + ``` + npm run start + ``` +Electrium Shop should now be running on [localhost:3000](http://localhost:3000/). ## More Supabase examples