Skip to content

Latest commit

 

History

History
55 lines (43 loc) · 1.68 KB

README.md

File metadata and controls

55 lines (43 loc) · 1.68 KB
Raw

Notes

Getting Started Locally

Ensure Docker is installed, then start the project with:

npm start

Here's a brief summary of the setup:

  • Web Application (or some service) running on http://localhost:8080.
  • PGAdmin4 (a PostgreSQL management tool) accessible at http://localhost:5050 (login: dev@gmail.com; password: qwerty123).
  • Backend server debugger on 127.0.0.1:9929.
  • Frontend server debugger on 127.0.0.1:9928.
  • Automatic restarts using nodemon inside Docker containers.

Project Goal

This project is designed to facilitate the creation and management of notes using Markdown. It includes features for editing, searching, archiving, and deleting notes.

The project serves as a practical exercise to deepen DevOps and Backend competencies and best practise.

DevOps Features

The project incorporates several fundamental DevOps features:

  • Monorepo with Lerna
  • Automated CI/CD with GitHub Actions:
    • Project validation on pull requests
    • Automatic tagging and releases
    • Docker image publishing
    • Automatic updates of running Docker containers on AWS EC2
  • Integration with AWS Services:
    • IAM
    • Authentication providers
    • EC2
    • S3
    • System Manager
  • Docker Compose for Local Development
  • Docker Swarm for Production
  • Logging
  • Build Tools and Linters: compilers (SWC, Rollup), linters, prettifiers, etc.
  • Nginx for Development and Production

Backend Features

  • Express
  • Integrations with Google Sign in and Facebook Login
  • PostgreSQL Database:
    • Direct SQL queries with pg (no TypeORM)
  • Custom Migration Tools:
    • Simple and efficient migration (only one direction) scripts
  • Separate Frontend Server:
    • Caches and serves files from S3