Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eric-philippe/todoapp

3 Tiers TodoApp centered on good practices during School
https://github.com/eric-philippe/todoapp

docker-compose good-practices todo

Last synced: 1 day ago
JSON representation

3 Tiers TodoApp centered on good practices during School

Host: GitHub
URL: https://github.com/eric-philippe/todoapp
Owner: Eric-Philippe
License: mit
Created: 2024-10-18T13:04:17.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-11-06T10:52:58.000Z (3 months ago)
Last Synced: 2024-12-12T19:13:24.163Z (about 2 months ago)
Topics: docker-compose, good-practices, todo
Language: TypeScript
Homepage:
Size: 1.16 MB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # ToDoApp

![CI/CD](https://github.com/Eric-Philippe/ToDoApp/actions/workflows/ci-cd.yml/badge.svg)

## Description

A simple TODO application under Docker environment with NestJS and Svelte. This project was made as a school project in order to have the best practices of a fullstack application. This project does not aim to be a complete application but rather a foundation to apply the best practices of a fullstack application.

## Table of Contents

- [ToDoApp](#todoapp)

  - [Description](#description)

  - [Table of Contents](#table-of-contents)

    - [🖼️ Illustration](#️-illustration)

  - [💽 Technologies](#-technologies)

  - [🐳 Running the app on docker](#-running-the-app-on-docker)

    - [🐋 Docker build \& start](#-docker-build--start)

    - [💾 Migration](#-migration)

  - [🖲️ Running the app without docker](#️-running-the-app-without-docker)

    - [⏏️ Installation](#️-installation)

    - [💾 Migration (without docker)](#-migration-without-docker)

  - [🎬 Running the app](#-running-the-app)

  

> Check the [CHANGELOG](./CHANGELOG.md) for the latest changes.

### 🖼️ Illustration

![Main Page](./images/main.png)

![Login Page](./images/login.png)

## 💽 Technologies

* NestJS

* TypeORM

* Svelte

* PostgreSQL

* PGadmin4

* JWT

* Docker

* Swagger

![Swagger](./images/swagger.png)

## 🐳 Running the app on docker

### 🐋 Docker build & start

```bash

# docker env build

$ docker-compose build

# docker env start

$ docker-compose up

# remove docker container (services & networks)

$ docker-compose down

```

### 💾 Migration

```bash

# generate migration

$ docker-compose run nestjs npm run typeorm:generate AnyNameYouLike

# run migration

$ docker-compose run nestjs npm run typeorm:run

```

## 🖲️ Running the app without docker

### ⏏️ Installation

```bash

$ npm install

```

### 💾 Migration (without docker)

```bash

# generate migration

$ npm run typeorm:generate AnyNameYouLike

# run migration

$ npm run typeorm:run

```

## 🎬 Running the app

```bash

# development

$ npm run start

# watch mode

$ npm run start:dev

# production mode

$ npm run start:prod

```