Skip to content

Latest commit

 

History

History
101 lines (72 loc) · 5.94 KB

README.md

File metadata and controls

101 lines (72 loc) · 5.94 KB
Raw

LemonMart Server LemonMart Server

Easy to learn and use TypeScript Express.js server with REST, GraphQL, and MongoDB using Minimal MEAN for Lemon Mart

Angular Version CircleCI DeepScan grade Coverage Status

lemon-server

Watch the video: Do More with Less: Full Stack TypeScript

Get the book: Lemon Mart Server is covered in my book Angular for Enterprise Applications. You can get it at AngularForEnterprise.com.

Setup

  • Install Node.js v20
  • Recommended Editor/IDE: Visual Studio Code
  • For a magical development experience, download these VS Code Extensions:
  • npm install
  • This will kick off a script, which will run npm install on all child folders.
  • Run npm run init:env to configure your environment variables in .env files

Manually Setup Environment Variables

Skip over this if you already ran the automated command

  • Define a .env file at the project's root and set the MongoDB admin password. Do NOT commit this file.
MONGODB_ADMIN_PASS=your_password_goes_here
MONGODB_APPLICATION_DATABASE=app_db_name
MONGODB_APPLICATION_USER=app_user
MONGODB_APPLICATION_PASS=app_password
MONGO_URI=uri_to_mongodb

  • See more details about the MongoDB Docker container at duluca/minimal-mongo, which also contains instructions on how to set things up on AWS ECS.

    In your server application, use the application information to connect to the database. Sample connection URI: mongodb://app_user:app_password@localhost:27017/app_db_name?readPreference=primary

  • Sample .env file. Note: In configuring the MONGO_URI, instead of localhost or an IP address, you must specify database, which is the container's name as defined in docker-compose.yml file.

MONGODB_ADMIN_PASS=admin
MONGODB_APPLICATION_DATABASE=acme
MONGODB_APPLICATION_USER=john.smith
MONGODB_APPLICATION_PASS=g00fy
MONGO_URI=mongodb://john.smith:g00fy@database/acme
  • You need a separate .env file under Server for development purposes. Note: We specify localhost, not the docker-compose name here.
MONGO_URI=mongodb://john.smith:g00fy@localhost:27017/acme

Run

Development

  • For development purposes, run each service individually
    • Angular Web App: cd web-app then npm start -- which utilizes ng serve and will give you live reload. To debug, use Angular DevTools
    • Server: cd server then npm run watch or use the debugger within VS Code (debug configuration is already included)
    • Database: npm start:database from the root

Architecture

  • web-app: This folder contains the client-side Angular app, configured using Angular CLI along with its own individual Node.js server
  • server: This folder contains the server-side Node.js app that can be used to serve REST APIs, and it is capable of connecting to MongoDB
  • document-ts: The library to connect and query Mongo in an async, flexible and convenient manner
  • duluca/minimal-mongo: A fully-featured Mongo image (with Auth and SSL) inherited from the official image.

Continuous Integration and Hosting

  • CI is implemented on CircleCI CircleCI
  • Hosted on AWS ECS
    • You'll need to publish your Docker containers to ECS individually
    • Then update docker-compose.aws.yml to pull from the ECS repository
    • Run npm run publish:aws on the root folder to create the task definition
    • You'll need to create a new service and attach this task definition to it
    • See the Step-by-Step AWS ECS Guide on how to create container repositories, and attaching a task definition to a service here.
    • See the Configuring AWS ECS to have access to AWS EFS Guide to persist data using MongoDB here.

REST

The OpenAPI schema for the project is hosted on /api-docs using SwaggerUI.

GraphQL

Apollo Explorer is hosted on /graphql.