https://github.com/darnley/ng-express
Basic ready for production Angular application with ExpressJs server render
https://github.com/darnley/ng-express
angular docker expressjs ready-to-use
Last synced: 2 months ago
JSON representation
Basic ready for production Angular application with ExpressJs server render
- Host: GitHub
- URL: https://github.com/darnley/ng-express
- Owner: darnley
- License: mit
- Created: 2019-07-07T19:32:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T07:34:33.000Z (over 3 years ago)
- Last Synced: 2025-06-16T17:26:09.137Z (about 1 year ago)
- Topics: angular, docker, expressjs, ready-to-use
- Language: TypeScript
- Homepage:
- Size: 697 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NgExpress
Basic ready for production Angular application with ExpressJs server render
## Installation
Use the package manager [npm](https://www.npmjs.com/) to install NgExpress.
It is not a installable package. You must download it in a ZIP file and unpack in your favorite folder.
## Usage
### Development environment
First of all, rename the `.env.example` file to `.env`. It will be used as an application configuration file. In the production environment, you are supposed to overwrite those configurations.
In development environment you can just run the following command in NgExpress root folder. It will install all the dependencies for NgExpress and the Angular application inside `/app` folder.
```bash
$ npm install
```
If you would like to run the application watching its changes, just run the following command. It will also run `npm install`.
```bash
$ npm start
```
### Production environment
This package is ready for Docker. If you build the image and run the container, the application is ready for usage.
If you would like to publish the code yourself, just run the following command in the application's root folder.
```bash
$ npm run prod
```
It will compile the Angular application into `/dist` folder in production mode. After that, you are free to delete `/app` folder in production environment to reduce disk usage.
After compiling your Angular application, change the `NODE_ENV` in your environment variables or in `.env` file to `production`. It will enable the application caching (in `cache.js` file).
Last of all, execute the application using you Node.js runtime.
```bash
$ node ./index.js
```
The Dockerfile uses [PM2](http://pm2.keymetrics.io) to manage the Node.js process. You are free to use another process manager.
#### Using Dockerfile
First of all, you should build your Docker image. In a command prompt of your choice, run the following command to create an image. The `-t` flag lets you tag your image so it's easier to find later using the `docker images` command.
```bash
$ docker build -t / .
```
Your image will now be listed by Docker.
```bash
$ docker images
# Example
REPOSITORY TAG ID CREATED
node 10 1934b0b038d1 5 days ago
/ latest d64d3505b0d2 1 minute ago
```
Running your image with `-d` runs the container in detached mode, leaving the container running in the background. The `-p` flag redirects a public port to a private port inside the container. Run the image you previously built.
```bash
$ docker run -p 49160:3000 -d /
```
The `49160` is the host port which will forward the traffic to port `3000` in Docker machine. In this example, just access `http://localhost:49160` through your favorite browser. You are free to change this port.
## Using another Angular application
This package is delivered with a standard and basic Angular application. If you would like to use your already existent Angular application, just follow these steps:
- Remove all the files from `/app` folder
- Copy your existent Angular application or create a new one in `/app` folder
You must have `@angular/cli` globally installed, otherwise you should modify the scripts in the `package.json` file.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)