Get started

Hey maker, welcome to ShipAngular 👋

Here's a quick overview of the SSR boilerplate. Follow along to get your app up and running.

Once you're done, start with this tutorial to launch your project in 5 minutes. Let's build that startup, FAST ⚡️

Start a local server

1. In your terminal, run the following commands one-by-one:

terminal

git clone https://github.com/jaydedevyn/ship-angular.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
git checkout firebase
npm install
git remote remove origin
npm start

git clone https://github.com/jaydedevyn/ship-angular.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]
git checkout supabase
npm install
git remote remove origin
npm start

ShipAngular requires Node 18.17 or greater. Type node -v in your terminal to check version.

2. Open http://localhost:4200 to see your site. And voila!

You will see errors in the console but nothing important.

Angular project structure

/src/app/pages → Pages (1 Folder = 1 Page)
/src/app/api → API calls (1 file = 1 API endpoint)
/src/app/components → Shared components
/src/app/guards → Page/Component Guards (Auth, etc.)
/src/app/interfaces → Frontend Interfaces
/src/app/pipes → Angular pipes
/src/app/services → Service layer to hit endpoints (Stripe & Mailgun, auth etc.)

Config.ts file

It is where you configure your app. Each key is documented to know how and why it's used. Have a thorough look at it: it is the backbone of the app.

/environments/environment.ts file

This is where you will store all your environment variables

environment.ts

export const environment = {
  production: true,
  apiBaseUrl: 'YOUR_API_BASE_URL',
  firebase: {
    apiKey: "",
    authDomain: "",
    databaseURL: "",
    projectId: "",
    storageBucket: "",
    messagingSenderId: "",
    appId: "",
    measurementId: ""
  },
};
;

export const environment = {
  production: true,
  supabaseUrl: 'YOUR_SUPABASE_URL',
  supabaseKey: 'YOUR_SUPABASE_KEY',
  apiBaseUrl: 'YOUR_API_BASE_URL',
};
;

Now go ahead and follow this tutorial to get your startup live within 5 minutes!