You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Alexi Taylor ee19dab73a
create stale.yml
4 months ago
.github create stale.yml 4 months ago
client Fix .env issue on client side (#33) 1 year ago
server/project Added abstract classes and extended entities to use abstract class. (#37) 10 months ago
.env 🌱 Implemented seeding process script 1 year ago
.gitignore 📄 Update README 1 year ago
.graphqlconfig Migrate from graphql.config.json to .graphqlconfig (#35) 1 year ago
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md 1 year ago
LICENSE Create LICENSE 1 year ago
README.md Update README.md 9 months ago
docker-compose.yml Change docker-compose settings to include env variables 1 year ago
graphql.schema.json Implement NestJs with GraphQL and TypeORM Server 1 year ago
renovate.json 🔧 Update renovate bot configs 1 year ago

README.md

🚀Angular 8 + GraphQL + NestJS + Postgres Starter Kit

A full-stack starter kit with Angular 8, GraphQL, Apollo, NestJS and Postgres.

Starting a new web app can be hard. Choosing the right technologies, architecting the foundation and developing the core of an application can take a lot of time. Setting up a back-end and front-end requires a substantial amount of work. Furthermore, if you don't do things correctly, it can create technical debt, painless refactoring, and maintenance hell. We take care of all the tedious, mundane setup process for you.

This stater kit provides you with a kick start to your project by providing a scalable, modular web app with features like sign up and log in, user management, easy database configuration and more. We carefully curated cutting-edge technologies for a full-stack application. View the full list of features below.

Happy Coding :)

Buy Me A Coffee

Features

Table of Contents

⬆️ Getting Started

⬆️ Requirements

Follow this guide to setup your mac dev environment.

⬆️ Installation

  • Fork the repo
  • git clone git@https://github.com/<yourusername>/angular-graphql-express-postgres-starter-kit.git
  • cd angular-graphql-express-postgres-starter-kit
  • git remote add upstream git@https://github.com/alexitaylor/angular-graphql-express-postgres-starter-kit.git

⬆️ Client

  • cd client
  • npm install
  • npm start
  • visit http://localhost:4200

Get started with these tasks:

  • $ npm start: start dev server with live reload on http://localhost:4200
  • $ npm run build: build web app for production
  • $ npm test: run unit tests in watch mode for TDD
  • $ npm run test:ci: lint code and run units tests with coverage
  • $ npm run e2e: launch e2e tests
  • $ npm run docs: show docs and coding guides
  • $ npm run prettier: format your code automatically

⬆️ Server

Installation

$ cd server/project
$ npm install

Create Database

  • Required only initial setup
  • Find default Postgres Database Configs by navigating to server/project/ormconfig.json file
  • Connect to Postgres shell: psql postgres
  • Create database:
postgres=# create database nest_graphql_test;
CREATE DATABASE

Seed Database

  • Run the following command to seed your database with default and random generated data:
$ npm run seedData
  • WARNING: Running this file will DELETE ALL data in your database and re-generate and insert new, random.
  • BE CAREFUL running this command in production env. It will delete all production data. The script will check if the environment you're running in is production or not by checking server/project/src/environments/environment.ts file configs. If environment.production config is set to true, then the seeding process will only generate default roles and 2 default users. This is useful when first setting up your production environment.

Running the server

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Required for Docker

Fill out .env file with postgres env variables

bash $ touch .env

POSTGRES_PASSWORD=supersecret
POSTGRES_USER=user
POSTGRES_DB=db

DATABASE=db
DATABASE_USER=user
DATABASE_PASSWORD=supersecret
DATABASE_HOST=postgres
DATABASE_PORT=5432

⬆️ Contributing

Anyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines:

⬆️ Cheat Sheets

⬆️ TODO:

  • Implement TypeORM migrations and default data on initial setup
  • Write Docker setup and configuration README
  • More tests
  • Entity Generator (able to create BE and FE models, GraphQL queries/mutations and some FE boilerplate code from an defined entity.