https://github.com/rusiruavb/portfolio-api

Backend API for my portfolio
https://github.com/rusiruavb/portfolio-api

docker express jsonwebtoken nodejs typescript

Last synced: 3 days ago
JSON representation

Backend API for my portfolio

• Host: GitHub
• URL: https://github.com/rusiruavb/portfolio-api
• Owner: rusiruavb
• License: mit
• Created: 2021-06-05T07:35:16.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-07-18T12:22:03.000Z (over 3 years ago)
• Last Synced: 2023-03-09T02:05:40.885Z (over 1 year ago)
• Topics: docker, express, jsonwebtoken, nodejs, typescript
• Language: TypeScript
• Homepage: https://ravb-portfolio-prd.herokuapp.com/
• Size: 133 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Rusiru Abhisheak Portfolio - API

### Backend API for my new portfolio site.

#### Production Link - 

#### Development Link - 

This is backend API for my portfokio site. Technology that I am using to implement this application is **Typescript**, **Node JS**, **Express**, **MongoDB** and **Firebase**.

The source code of this applications is publically available. So, you can also add modifications to this code to create your own portfolio site.

### How to things get start

1. Fork or clone the application by using this URL :fork_and_knife: 

2. Open the project using a code editor (VS Code, Web Storm)

3. Create your own database in MongoDB Atlas

4. Get the connection string

5. Go to the `config` folder and paste the connection string to the `dbUri`

6. Type this command to install the application dependencies

> `npm install` or `npm i`

7. Run this command to start the application

> `npm run dev` This will start the backend server on PORT 9098 and connect to the database.

### To See more documentation

> Go to the `documentation` folder inside the project structure.

## Run the application using Docker container

#### How to set up and run the application

1. Install **Docker** into your local computer.

2. Pull the docker image using **docker pull rusiruavb/conference-api-docker:latest**

3. Run **docker run -p 8045:9094 rusiruavb/portfolio-api:latest** command to create the docker container and run.

4. Then the application will be exposed on port 8045.

5. Navigate to your browser and copy/paste this link **http://localhost:8045/**