external/my-finance-pal-backend
1
0
Fork 0
mirror of https://github.com/netlight/my-finance-pal-backend.git synced 2024-09-20 04:31:07 +02:00
Code Issues Projects Releases Packages Wiki Activity
No description
27 commits 15 branches 0 tags 441 KiB
TypeScript 76%
HCL 22.9%
Dockerfile 1.1%
Find a file
Alexander Ungar a2bcfe7f1a Add missing vars to production env
2023-04-01 11:57:31 +02:00
api Shorten API spec 2023-03-31 18:18:04 +02:00
env Add missing vars to production env 2023-04-01 11:57:31 +02:00
src Fix linter errors 2023-03-31 18:10:04 +02:00
terraform Added terraform main file for cloudrun deployment. 2023-03-28 22:58:09 +02:00
.dockerignore Introduce Dockerfile for containerizing the application 2023-03-22 13:02:32 +01:00
.eslintrc Add initial app with use case 2023-03-14 23:38:19 +01:00
.gitignore Add initial app with use case 2023-03-14 23:38:19 +01:00
docker-compose.yml Add the app to the local docker-compose setup 2023-03-22 13:03:00 +01:00
Dockerfile Introduce Dockerfile for containerizing the application 2023-03-22 13:02:32 +01:00
package.json Migrate to CommonJS 2023-03-27 10:06:28 +02:00
README.md Add readme 2023-03-31 19:06:21 +02:00
tsconfig.json Migrate to CommonJS 2023-03-27 10:06:28 +02:00
tsconfig.prod.json Add initial app with use case 2023-03-14 23:38:19 +01:00
yarn.lock Check in the yarn.lock file 2023-03-22 13:01:03 +01:00

README.md

Contributors Forks Stargazers Issues LinkedIn


My Finance Pal

Example Typescript Node.js webserivce showcasing best practices in software development
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage

About The Project

This is a standalone best practice web application developed for an engineering bootcamp for a lecture at the Technical University of Munich.

Please bear in mind that also this is not a perfect version of an application as one would imagine it running in production in a real world scenario. However, we tried to incorporate as many best practices as possible, but as few as needed to get students, who are on a beginner level, started. The goal is to have this is a toolbox for developing a state-of-the art Node.js Typescript business application.

Don't take everything we do in this application literally. It is important to also always think for yourself and consider which of the presented techniques and frameworks you actually need for your use case!

At the end, we hope that this helps you on your journey on becoming an amazing software developer and we hope you have fun exploring the universe of backend engineering :)

(back to top)

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • NodeJs
  • Express.js
  • Typescript
  • MongoDB
  • Jest

(back to top)

Getting Started

In order to be able to start the service locally, follow these required steps.

Prerequisites

Needed toolings and frameworks you should install before building the project

  • Node.js (if not already installed)
  • Update npm 
    npm install npm@latest -g
  • Yarn 
    npm install yarn -g

Installation

  1. Clone the repo 
    git clone https://github.com/ungaralex/my-finance-pal-backend.git
  2. Install NPM packages 
    yarn install

(back to top)