Getting Started

Welcome to the documentation of Equilibre 🥳.

I hope that everything will go well for you and that you will launch your new project very soon. If you need help, feel free to ask your questions on Slack!

Prerequisites

Before getting started, please make sure you have installed the recommended setup.

• Node.js* (latest LTS version)
• Visual Studio Code
• Volar Extension

If you already have Node.js installed, check with node --version above 16.11.

External documentations

If you are not familiar with Nuxt and/or Supabase, we strongly recommend that you read their documentation before starting to work with Equilibre.

• Nuxt documentation
• Supabase documentation

Installation

First, use the link you got after your purchase to clone the project. Then go to the equilibre folder, and start the installation:

yarn install

npm install

Supabase

Create your Project

Create a new Supabase project. You'll need to put the following information in your .env file:

• SUPABASE_KEY: Your Supabase API key.
• SUPABASE_URL: Your Supabase API url.
• SUPABASE_SERVICE_KEY: Your Supabase service key.

Create a .env and fill it with these information. You can copy the .env.example content.

Fill your database

At the root of the project, you will see a starter_sql file. Open it and copy its contents.

Paste it into the SQL Editor of Supabase (SQL Editor -> New query).

Your database is now ready 🥳. You can begin configuring your social logins if you want.

Launch

You're ready to dive in! You can now launch your project

yarn run dev

npm run dev