Skip to content

Commit f4a0870

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

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Welcome to the first dark dashboard with Google Material Design and Angular!
44

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

7-
Its much more fun with the [demo](http://material-angular-dashboard.creativeit.io).
7+
Its much more fun with the [demo](https://g5ope910kg.execute-api.eu-central-1.amazonaws.com/production/).
88

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

@@ -20,34 +20,41 @@ The steps below will take you through cloning your own fork, installing dependen
2020
git clone https://github.com/CreativeIT/material-angular-dashboard.git
2121
```
2222

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

2525
```bash
26-
git checkout feature/backend
26+
git checkout feature/serverless
2727
```
2828

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

3131
```bash
3232
npm install
33-
# then for backend
34-
cd backend
35-
npm install
3633
```
3734

38-
4. Install [angular-cli](https://cli.angular.io/) globally to use its commands in the terminal:
35+
4. Install [serverless](https://serverless.com/) globally to use its commands in the terminal:
36+
37+
```bash
38+
npm install --global serverless
39+
```
40+
41+
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/):
3942

4043
```bash
41-
npm install --global @angular/cli
44+
pip install awscli
4245
```
4346

44-
5. Now you are able to run or build the project:
47+
6. [Configure](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-configure.html) awscli:
4548

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.
49+
```bash
50+
aws configure
51+
```
52+
53+
7. Now you are able to deploy the project:
4754

48-
Go to `backend` directory and run `npm start` to start node.js backend.
55+
Run `npm run build:serverless:deploy` to deploy the project to AWS Lambda. You will get the URL for your project.
4956

50-
Navigate to `http://localhost:4200/`. Use the following credentials to sign in the Dashboard: user: _[email protected]_ , password: _admin_
57+
Navigate to the given URL. Use the following credentials to sign in the Dashboard: user: _[email protected]_ , password: _admin_
5158

5259
# FEATURES
5360

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

6269
* [Express](https://expressjs.com/)
6370

71+
* [AWS Lambda](https://aws.amazon.com/lambda/)
72+
73+
* [Serverless](https://serverless.com/)
74+
6475
* Responsive dark material design. DARK, Carl!
6576

6677
* User experience focused

0 commit comments

Comments
 (0)