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 :)
- Angular 8.X (w/ TypScript)
- GraphQL
- NestJS server
- TypeORM
- Apollo
- Bootstrap 4
- Postgres
- Authentication w/ JWT and local storage
- Authorization
- User Management
- Entity Management
- E2E testing
- Docker Compose
⬆️ 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.gitcd angular-graphql-express-postgres-starter-kitgit remote add upstream git@https://github.com/alexitaylor/angular-graphql-express-postgres-starter-kit.git
⬆️ Client
cd clientnpm installnpm start- visit
http://localhost:4200
- $ 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
$ cd server/project
$ npm install- Required only initial setup
- Find default Postgres Database Configs by navigating to
server/project/ormconfig.jsonfile - Connect to Postgres shell:
psql postgres - Create database:
postgres=# create database nest_graphql_test;
CREATE DATABASE- If
postgresuser does not exist: 1. Create a new user and 2. Change user's role
- 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.tsfile 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.
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod- Visit http://localhost:4000/graphql for GraphQL playground
- Getting Started with GraphQL visit here
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.