Giter Club home page Giter Club logo

notes's Introduction

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: [email protected]; 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

notes's People

Contributors

kallenju avatar github-actions[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.