tarlepp / angular-ngrx-frontend

Angular NgRx powered frontend template for Symfony (or similar) backend

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

What is this?

MIT licensed CI OpenSSF Scorecard

Angular NgRx powered frontend template project for Symfony Flex Backend or any other backend that is providing similar API.

Table of Contents

Requirements

Recommendations

  • *nix platform - most likely you're going to host your application on *nix platform - so I would recommend to do development also on that platform.
  • Makefile support - if you don't have this you need to look Makefile file to see what each make command is doing.

Installation

1. Clone repository

Use your favorite IDE and get checkout from GitHub or just use following command

git clone https://github.com/tarlepp/angular-frontend.git

2. Start containers

For this just run following command:

make start

This command will create one (1) Docker container where your application is running on development stage.

3. Using application

By default make start command starts Angular application on Docker container and exposes following port on localhost (note that application is using https):

  • 4200 (Angular Live Development Server)

And this application is usable within your browser on https://localhost:4200 address. When you first time open that site you will see "Your connection is not private" warning - see this to resolve that.

Note that this frontend application assumes that your backend is running on https://localhost:8000 address. Also note that "default" backend is running on that address by default.

4. Getting shell to container

After you've run make start command you can list all running containers with docker ps command.

And to eg. get shell access inside one of those containers you can run following shortcut command:

make bash

Where that node is that actual container where this backend application is running.

5. Building containers

For time to time you probably need to build containers again. This is something that you should do always if you have some problems to get containers up and running. This you can do with following command:

make start-build

Resources

External links / resources

Authors

License

The MIT License (MIT)

Copyright © 2023 Tarmo Leppänen

About

Angular NgRx powered frontend template for Symfony (or similar) backend

License:MIT License


Languages

Language:TypeScript 80.7%Language:SCSS 9.9%Language:HTML 4.7%Language:Makefile 2.7%Language:JavaScript 1.1%Language:Shell 0.8%Language:Dockerfile 0.2%