Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eltonlazzarin/nodejs-aws-deploy
Simple Jobs API built in Node.js and deployed on AWS
https://github.com/eltonlazzarin/nodejs-aws-deploy
amazonwebservice awscloud awsec2 awsexperience awsskills backenddeveloper becomeacloudexpert developer docker dockercompose dockermachine javascript javascriptapp nodeapi nodejs nodejsapplications programming
Last synced: 3 days ago
JSON representation
Simple Jobs API built in Node.js and deployed on AWS
- Host: GitHub
- URL: https://github.com/eltonlazzarin/nodejs-aws-deploy
- Owner: eltonlazzarin
- License: mit
- Created: 2020-10-31T22:15:40.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2020-11-08T02:58:16.000Z (about 4 years ago)
- Last Synced: 2024-10-12T12:23:39.800Z (about 1 month ago)
- Topics: amazonwebservice, awscloud, awsec2, awsexperience, awsskills, backenddeveloper, becomeacloudexpert, developer, docker, dockercompose, dockermachine, javascript, javascriptapp, nodeapi, nodejs, nodejsapplications, programming
- Language: JavaScript
- Homepage: http://ec2-35-175-146-94.compute-1.amazonaws.com:3000
- Size: 1.79 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Simple Jobs API built in Node.js and deployed on AWS
About The Project |
Backend Technologies |
Backend Getting Started |
How To Contribute |
Backend License
## 👨🏻💻 About the project
This project consists of a simple API that shows some fictional jobs, but the main purpose was to create it to deploy to AWS for learning purposes with the cloud platform, where an EC2 instance was created and an application was uploaded Node.js which is the API itself within a Docker image and finally expose this API on the internet publicly.
## 🚀 Backend Technologies
Technologies that I used to develop this api
- [Node.js](https://nodejs.org/en)
- [Express](https://github.com/expressjs/express)
- [VS Code](https://code.visualstudio.com) with [EditorConfig](https://marketplace.visualstudio.com/items?itemName=EditorConfig.EditorConfig) and [Prettier RC](https://github.com/prettier/prettier)
## 💻 Backend getting started
### Requirements
- [Node.js](https://nodejs.org/en/)
- [Yarn](https://classic.yarnpkg.com/) or [npm](https://www.npmjs.com/)
- [Docker CLI](https://docs.docker.com/engine/reference/commandline/cli)
- [Docker-Compose CLI](https://docs.docker.com/compose/reference/overview)
- [Docker-Machine CLI](https://docs.docker.com/machine/install-machine)
- [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
- [AWS Free Account](https://aws.amazon.com/free/)
**Clone the project and access the folder**
```bash
$ git clone https://github.com/eltonlazzarin/nodejs-aws-deploy.git
$ cd nodejs-aws-deploy
```
**Follow the steps below**
```bash
# Install the dependencies
$ yarn
```
## 💻 Run API Locally
**Creating Docker environment with Node.js**
```bash
# Create docker enviroment
$ docker-compose up
```
**Run the API**
```bash
# Run the API
$ yarn start
```
**Acccess the API**
http://localhost:3000
## 💻 Deploy API on AWS
**Generating AWS account permissions**
```bash
$ aws configure
# AWS Console -> AWS User -> My Security Credentials -> AWS IAM credential and click Create access key button and then copy Access key ID and paste bellow
AWS Access Key ID [***************CTPA]:
```
**Create an EC2 instance on AWS**
```bash
$ docker-machine create --driver amazonec2 INSTANCE_NAME
```
**Connect the terminal to EC2 instance**
```bash
$ eval $(docker-machine env INSTANCE_NAME)
```
**Create docker image in EC2 instance**
```bash
$ docker-compose up -d
```
**Expose port 3000 on AWS**
EC2 -> Security Groups -> Select docker-machine -> Inbound -> Edit -> Add Rule -> Type: Custom TCP Rule -> Protocol: TCP -> Port Range: 3000 -> Source: Custom -> 0.0.0.0/0 -> Save
**Access your API**
EC2 -> Instances -> Select your instance -> Copy and paste Public DNS (IPv4) on your web browser followed by the port, like http://ec2-3-89-91-138.compute-1.amazonaws.com:3000
**Disconnect terminal to EC2 instance**
```bash
$ eval $(docker-machine env INSTANCE_NAME -u)
```
## 🤔 How to contribute backend
**Follow the steps below**
```bash
# Clone your fork
$ git clone https://github.com/eltonlazzarin/nodejs-aws-deploy.git
$ cd nodejs-aws-deploy
# Create a branch with your feature
$ git checkout -b your-feature
# Make the commit with your changes
$ git commit -m 'feat: Your new feature'
# Send the code to your remote branch
$ git push origin your-feature
```
After your pull request is merged, you can delete your branch
## 📝 Backend License
This project is under the MIT license. See the [LICENSE](https://github.com/eltonlazzarin/nodejs-aws-deploy/blob/master/LICENSE) for more information.
---
Made with ♥ by Elton Lazzarin :wave: [Get in touch!](https://www.linkedin.com/in/eltonlazzarin/)