https://github.com/onlineeric/eric-demo-express-ts

Eric Demo Express Server
https://github.com/onlineeric/eric-demo-express-ts

Last synced: 6 days ago
JSON representation

Eric Demo Express Server

• Host: GitHub
• URL: https://github.com/onlineeric/eric-demo-express-ts
• Owner: onlineeric
• License: mit
• Created: 2024-10-07T09:32:58.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-12-27T05:47:55.000Z (over 1 year ago)
• Last Synced: 2024-12-27T06:25:13.989Z (over 1 year ago)
• Language: TypeScript
• Homepage:
• Size: 118 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Eric Demo Express Server

Welcome! I'm Eric Cheng, and this repository is one of my personal demo project to showcase my full stack and AI development skills.

This project serves as a demonstration of my Node Js Express Server knowledge and its API development paradigms. It is a simple Express server that serves as a backend for my [Eric Demo React App](https://agreeable-water-061d90800.5.azurestaticapps.net)

![Node.js](https://img.shields.io/badge/-Node.js-339933?logo=node.js&logoColor=white)

![Express](https://img.shields.io/badge/-Express%20JS-FFFF00?logo=express&logoColor=black)

![TypeScript](https://img.shields.io/badge/-TypeScript-007ACC?logo=typescript&logoColor=white&style=flat)

![GraphQL](https://img.shields.io/badge/-GraphQL-E10098?logo=graphql&logoColor=white)

![Jest](https://img.shields.io/badge/-Jest-C21325?logo=jest&logoColor=white)

![GitHub](https://img.shields.io/badge/-GitHub-181717?logo=github&logoColor=white)

![CI/CD](https://img.shields.io/badge/-CI%2FCD-5C6BC0?logo=jenkins&logoColor=white)

![GitHub Actions](https://img.shields.io/badge/-GitHub%20Actions-2088FF?logo=github-actions&logoColor=white)

![Docker Hub](https://img.shields.io/badge/-Docker%20Hub-2496ED?logo=docker&logoColor=white)

![Azure](https://img.shields.io/badge/-Azure-0089D6?logo=microsoft-azure&logoColor=white)

## Demo Site

You can view [My Demo Website](https://agreeable-water-061d90800.5.azurestaticapps.net) built using React, connected to this Express API, a C# backend and a GoLang backend.

## Goals

1. Demonstrate my Node Js, Typescript and Express server knowledge.

2. Demonstrate both Restful API and GraphQL API.

3. Demonstrate CICD pipeline setup with Github Actions, Docker Hub and Azure Web App.

4. Keep it as a simple reference for my personal use.

## Project Ambition

Beyond this Express Server implementation, my overarching objective is to create a multi-language demo project that showcases my knowledge and skills. [My Demo Website](https://agreeable-water-061d90800.5.azurestaticapps.net) is connected to this Express server, another API server in C#, and anotehr API server in GoLang.

## Installation and Running

To install the project, make sure you have Node Js installed, then clone the repository:

https://github.com/onlineeric/eric-demo-express-ts.git

cd into the project directory, and run the project with:

Install dependencies: `yarn`

Run the project: `yarn start`

Test the project: `yarn test`

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details