Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ekaterinagorbunova/burger-house

App for ordering burgers. Built using Angular, TypeScript
https://github.com/ekaterinagorbunova/burger-house

angular css netlify-deployment typescript

Last synced: 24 days ago
JSON representation

App for ordering burgers. Built using Angular, TypeScript

Awesome Lists containing this project

README

        

# Burger House Landing App

This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 16.2.12.

## Development server

Run `npm install` to install all the necessary npm packages.

Run `ng serve --open` for a dev server. The server will automatically open in the browser at `http://localhost:4200/`. The application will reload automatically if you make any changes to the source files.

## Code scaffolding

Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.

Example:

Run `ng generate service App` to generate `app.service.ts` file (for ex. to store the logic of connecting to the backend)

## Build and Deploy to GitHub Pages

1. Increase size of the application up to 1mb in `angular.js` to get rid of build warnings:

```
"budgets": [
{
"type": "initial",
"maximumWarning": "1mb",
"maximumError": "1mb"
},
{
"type": "anyComponentStyle",
"maximumWarning": "1mb",
"maximumError": "1mb"
}
],
```

2. Make sure that `src\index.html` file uses root directory:
```

```

3. Setup GitHub Pages

https://medium.com/tech-insights/how-to-deploy-angular-apps-to-github-pages-gh-pages-896c4e10f9b4

#### First time setup

```
// create gh-pages branch and switch to it
git checkout -b gh-pages

// push the existing code to gh-pages branch
git push origin gh-pages

// install 'angular-cli-ghpages' globally
npm install -g angular-cli-ghpages

// build your angular app with --base-href flag
ng build --configuration=production --base-href https://[username].github.io/[reponame]/

// push the built code located in dist/[project-name] folder to GitHub Pages (gh-pages branch)
ngh --dir=dist/[project-name]
```

*ngh - means angular github pages*

#### Subsequent deploys

We make all changes to the source code, subsequent builds and pushes to GitHub Pages (`gh-pages` branch) from the `main` branch:

```
git checkout main

ng build --configuration=production --base-href https://[username].github.io/[reponame]/

ngh --dir=dist/[project-name]
```

*Example of commands:*

```
ng build --configuration=production --base-href https://EkaterinaGorbunova.github.io/burger-house/
ngh --dir=dist/burger-house
```

Note: After deploying to GitHub Pages (`ngh --dir=dist/[project-name]`), it takes some time for the changes to take effect.

4. Check GitHub Pages Settings of your repo - `https://github.com[username]/[reponame]/settings/pages`. The branch should be `gh-pages` and `root` as the source folder:

![GitHub Pages](./src/assets/images/github-pages.png)

5. Check your deployment:

`https://github.com/YOUR_USERNAM/YOUR_REPONAME/deployments`

or

`https://YOUR_USERNAM.github.io/YOUR_REPONAME/`

## Deploy to Netlify (with linked GitHub repo)

*Note: No need to exclude `dist` folder from `.gitignore` file*

Base directory: /

Build command `ng build --configuration=production`

Publish directory: `/dist/YOUR_APPNAME`

![GitHub Pages](./src/assets/images/netlify-build-settings.png)

Production branch: `main`

![GitHub Pages](./src/assets/images/netlify-branches-settings.png)

## Further help

To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.