bluebloom18 / NUS-Fintech-Backend-test

Demo for VS Code

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

backend-test

This is a test backend server with APIs running on port 3000 based on a tutorial

The database is linked to a real Posgres database.

Please ask me for the .env file if you want to run the code

This readme.md follows a template I sourced from

https://dev.to/rohit19060/how-to-write-stunning-github-readme-md-template-provided-5b09

Links

Github Actions

When code is updated

  1. Build Docker .env file from secrets
  2. Build and push to Docker Hub when code changes (yaml file here: .github/workflows/main.yml)

To replicate and run

Gitclone, and in the project directory, you can run (but you need .env file):

"npm start"

DOCKER Workflow

Create docker image:

docker build -t image-name .

Run:

docker run -d -p 80:3000 --env-file .env image-name

Live Site

  • Hosted on Google Cloud Platform
  • Files pulled using git clone and then run using Docker (you need a .env file to access the database)

Built With

  • JavaScript
  • Node
  • NPM
  • Docker on VS code

Screenshot

Future Updates

  • Front End using React

Author

Lien Ber Luen

🤝 Support

Contributions, issues, and feature requests are welcome!

Give a ⭐️ if you like this project!

About

Demo for VS Code


Languages

Language:JavaScript 98.7%Language:Dockerfile 1.3%