Skip to content

Commit 11bf49b

Browse files
committed
docs: change README.md
1 parent 285a791 commit 11bf49b

File tree

1 file changed

+34
-14
lines changed

1 file changed

+34
-14
lines changed

README.md

Lines changed: 34 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
1-
# Material Angular Dashboard
21

3-
Welcome to the first dark dashboard with Google Material Design and Angular!
2+
# Material Angular Dashboard + AWS Lambda
3+
4+
Welcome to the first dark dashboard with Google Material Design and Angular powered with [AWS Lambda](https://aws.amazon.com/lambda/) deployment facility!
45

56
<a target="_blank" href="http://material-angular-dashboard.creativeit.io/"><img src="https://trello-attachments.s3.amazonaws.com/55f8466d8f95075bca20dd66/5bf421455ab0f05102cadac9/eee32e50e9fc278b715442a3fc6f65aa/Readme.png"/></a>
67

7-
Its much more fun with the [demo](http://material-angular-dashboard.creativeit.io).
8+
# Overview
9+
10+
This bundle contains the [`feature/backend`](https://github.com/CreativeIT/material-angular-dashboard/tree/feature/backend) bundle code and configuration for deployment on AWS Lambda.
11+
12+
AWS Lambda lets you run code without provisioning or managing servers. You pay only for the compute time you consume - there is no charge when your code is not running.
13+
14+
Its much more fun with the [demo](https://g5ope910kg.execute-api.eu-central-1.amazonaws.com/production/).
815

916
Material admin template is absolutely free for commercial usage theme, based on Google Material Design guidelines.
1017

@@ -20,34 +27,43 @@ The steps below will take you through cloning your own fork, installing dependen
2027
git clone https://github.com/CreativeIT/material-angular-dashboard.git
2128
```
2229

23-
2. Open your copied repo folder in terminal and checkout `feature/backend` branch to use bundle with backend.
30+
2. Open your copied repo folder in terminal and checkout `feature/serverless` branch to use bundle with serverless deployment configuration.
2431

2532
```bash
26-
git checkout feature/backend
33+
git checkout feature/serverless
2734
```
2835

2936
3. Install necessary modules, make sure that you have installed [npm](https://www.npmjs.com/get-npm):
3037

3138
```bash
3239
npm install
33-
# then for backend
34-
cd backend
35-
npm install
3640
```
3741

38-
4. Install [angular-cli](https://cli.angular.io/) globally to use its commands in the terminal:
42+
4. Install [serverless](https://serverless.com/) globally to use its commands in the terminal:
3943

4044
```bash
41-
npm install --global @angular/cli
45+
npm install --global serverless
4246
```
4347

44-
5. Now you are able to run or build the project:
48+
5. Install [awscli](https://aws.amazon.com/cli/) to manage AWS services (AWS Lambda in our case), make sure that you have installed [pip](https://pip.pypa.io/en/stable/installing/):
4549

46-
Run `npm start` or `ng serve` for a dev server. The app will automatically reload if you change any of the source files. Or run `npm run build` or `ng build` to build the project. The build artifacts will be stored in the `dist/` directory.
50+
```bash
51+
pip install awscli
52+
```
4753

48-
Go to `backend` directory and run `npm start` to start node.js backend.
54+
6. [Create IAM User](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users_create.html#id_users_create_console) for automatic project deployment, make sure that you have [AWS account]([https://aws.amazon.com/console/](https://aws.amazon.com/console/)). Grant it AdministratorAccess policy. Remember its access key pair.
4955

50-
Navigate to `http://localhost:4200/`. Use the following credentials to sign in the Dashboard: user: _[email protected]_ , password: _admin_
56+
7. [Configure awscli](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) with key pair given above:
57+
58+
```bash
59+
aws configure
60+
```
61+
62+
8. Now you are able to deploy the project:
63+
64+
Run `npm run build:serverless:deploy` to build and deploy the project to AWS Lambda. You will get the URL for your project.
65+
66+
Navigate to the given URL. Use the following credentials to sign in the Dashboard: user: _[email protected]_ , password: _admin_
5167

5268
# FEATURES
5369

@@ -61,6 +77,10 @@ Navigate to `http://localhost:4200/`. Use the following credentials to sign in t
6177

6278
* [Express](https://expressjs.com/)
6379

80+
* [AWS Lambda](https://aws.amazon.com/lambda/)
81+
82+
* [Serverless](https://serverless.com/)
83+
6484
* Responsive dark material design. DARK, Carl!
6585

6686
* User experience focused

0 commit comments

Comments
 (0)