Skip to content

1. Getting Started

Jump to bottom
Max Geller edited this page Oct 5, 2024 · 4 revisions

Getting Started

Prerequisites

Version Requirements:

  • Node.js 20.x
  • Angular CLI 18.x

Supabase Requirements:

You will need to have a Supabase account and project URL to use this project. You can create a new project URL and API key by visiting the Supabase website and creating a new project.

  • Supabase Account(s)
  • Supabase Project URL(s)
  • Supabase API Key(s)

Installation

Clone the repository to your local machine:

git clone https://github.com/your-username/angular-18-starter.git

Navigate to the project directory:

cd angular-supastarter

Install the dependencies:

npm install

Configuration

Environment Variables

Once you have a Supabaseproject URL and API key for both production and development environments, you can configure the project's environment variables by renaming the .env-sample file to .env, and updating the contents of the file with your Supabase project URLs and API keys. Be sure to add this file to your .gitignore file to prevent the API keys from being committed to the repository. This file should contain the following:

NG_APP_PROD_SUPABASE_URL=your-production-supabase-project-url
NG_APP_PROD_SUPABASE_KEY=your-production-supabase-project-key

NG_APP_DEV_SUPABASE_URL=your-development-supabase-project-url
NG_APP_DEV_SUPABASE_KEY=your-development-supabase-project-key

This project uses the ngx-env package to load the environment variables from the .env file. This package is installed automatically with the project.

SQL Schema Configuration

This project uses the ???? package to load the SQL schema from the schema.sql file. This package is installed automatically? with the project and will automatically create the tables and columns in the database when the project is built.

The SQL schema will also create an initial global admininstrator user, as well as initial user roles and permissions for the project.

Application Usage

Installation

To install the project, you can run the following command:

npm install

This will install the project dependencies and allow you to build the project.

Building the Project

To build the project, you can run the following command:

ng build

This will build the project and create a production build in the dist directory.

Running the Project

To run the project, you can run the following command:

ng serve -o

This will start the project and open the application in your default web browser at http://localhost:4200/.

First Time Setup

When you first run the project, you can login to the application using the Initial Administrator credentials as follows:

  • Email: admin@angular-starter.com
  • Password: Password42069!

Once logged-in using the Initial Admin credentials, it is recommended that you setup a permanent Global Administrator user in order to create additional users and tenants, and to setup the application settings, roles, and permissions.

Clone this wiki locally