Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/saltyshiomix/ark
An easiest authentication system on top of NestJS, TypeORM, NEXT.js(v9.3) and Material UI(v4).
https://github.com/saltyshiomix/ark
material-ui nestjs nextjs typeorm typescript
Last synced: 3 months ago
JSON representation
An easiest authentication system on top of NestJS, TypeORM, NEXT.js(v9.3) and Material UI(v4).
- Host: GitHub
- URL: https://github.com/saltyshiomix/ark
- Owner: saltyshiomix
- License: mit
- Archived: true
- Created: 2018-12-13T08:08:54.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-07T10:35:39.000Z (over 3 years ago)
- Last Synced: 2024-08-02T13:35:40.690Z (6 months ago)
- Topics: material-ui, nestjs, nextjs, typeorm, typescript
- Language: TypeScript
- Homepage:
- Size: 1000 KB
- Stars: 259
- Watchers: 10
- Forks: 17
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
An easiest authentication system on top of NestJS, TypeORM, NEXT.js (v9) and Material UI (v4).
## Features
- Cross platform - Mac, Linux and Windows
- Database synchronization with entities - powered by [TypeORM](http://typeorm.io)
- Server Side Rendering - powered by [NEXT.js](https://nextjs.org)
- API server - powered by [NestJS](https://nestjs.com)
- Authentication - powered by [Passport](http://www.passportjs.org)
- [Material UI](https://material-ui.com) design
## Technologies
- Hot reloading for the developer experience :)
- [ts-node-dev](https://github.com/whitecolor/ts-node-dev) - Compiles your TS app and restarts when files are modified
- [NEXT.js](https://nextjs.org) - The React Framework
- Lang
- [TypeScript](https://www.typescriptlang.org) - Javascript that scales
- Database
- [PostgreSQL](https://www.postgresql.org) - The World's Most Advanced Open Source Relational Database
- ORM (Object-relational mapping)
- [TypeORM](http://typeorm.io) - ORM for TypeScript and JavaScript (ES7, ES6, ES5)
- Server
- [NestJS](https://nestjs.com) - A progressive Node.js framework for building efficient, reliable and scalable server-side applications
- internally using [Express](https://expressjs.com) - Fast, unopinionated, minimalist web framework for Node.js
- [NEXT.js](https://nextjs.org) - The React Framework
- Environment variables
- [dotenv](https://github.com/motdotla/dotenv) - Loads environment variables from .env for nodejs projects
- [dotenv-webpack](https://github.com/mrsteele/dotenv-webpack) - A secure webpack plugin that supports dotenv and other environment variables and only exposes what you choose and use.
- User authentication
- [Passport](http://www.passportjs.org) - Simple, unobtrusive authentication for Node.js
- UI framework
- [React](https://reactjs.org) - A JavaScript library for building user interfaces
- [NEXT.js](https://nextjs.org) - The React Framework
- [Material UI](https://material-ui.com) - React components that implement Google's Material Design.
## Setup
### Database Setup
Ark uses [PostgreSQL](https://www.postgresql.org) **v11**.
#### For Mac Users
```bash
# install postgresql@11
$ brew install postgresql@11
# if you want to start postgresql@11 in startup, try do this
$ brew services start postgresql@11
# [MUST] create user "arkuser" with password "arkpass"
$ createuser -P arkuser
# [MUST] create database "arkdb" owened by "arkuser"
$ createdb arkdb -O arkuser
```
#### For Windows Users
##### Python
Because Ark uses [node.bcrypt.js](https://github.com/kelektiv/node.bcrypt.js), we need a Python:
- Download an installer at
- Install with "Add Python 3.X to PATH" checked
##### [windows-build-tools](https://github.com/felixrieseberg/windows-build-tools)
- Run `npm install --global --production windows-build-tools` from an elevated PowerShell or CMD.exe **as Administrator**
##### PostgreSQL
- Download an installer at (**v11**)
- Run the installer with a flag `--install_runtimes 0` like this:
```cmd
> postgresql-11.6-3-windows-x64.exe --install_runtimes 0
```
##### pgAdmin
- Download a latest installer at
- Run the pgAdmin and login with a root user
- Right click `Login/Group Roles` and `Create > Login/Group Role`
- `General` Panel:
- `Name`: `arkuser`
- `Definition` Panel:
- `Password`: `arkpass`
- `Priviledges` Panel:
- Check all `Yes`
- Right click `Databases` and `Create > Database`
- `General` Tab:
- `Database`: `arkdb`
- `Owner`: `arkuser`
### Application Setup
```bash
# prepare `.env` and edit it for your own environments
$ cp .env.example .env
# install dependencies
$ yarn
# development mode
$ yarn dev
# production mode
$ yarn build
$ yarn start
```
The `.env` file is like this:
```
DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=arkuser
DB_PASSWORD=arkpass
DB_DATABASE=arkdb
DB_SYNCHRONIZE=true
APP_PROTOCOL=http
APP_HOST=localhost
APP_PORT=4000
APP_SESSION_SECRET=ark
```
## Production Deployment
With production usages, please use [pm2](https://github.com/Unitech/pm2) for Node.js process managements.
```bash
# install pm2
$ npm install --global pm2
# run the app "ARK" with the config `ecosystem.config.js`
$ cd ark
$ pm2 start
```
The example `ecosystem.config.js`:
```js
module.exports = {
apps : [{
name: 'ARK',
script: '.next/production-server/main.js',
instances: 1,
autorestart: true,
watch: false,
max_memory_restart: '1G',
env: {
NODE_ENV: 'production'
}
}]
};
```
## Screenshots
### Register Page
### Login Page
### Top Page (Auth Guard)
## Articles
- [A road to the easiest user authentication system for Node.js](https://dev.to/saltyshiomix/a-road-to-the-easiest-user-authentication-system-for-nodejs-138f)
## Related
- [YARK](https://github.com/saltyshiomix/yark) - Yet another easiest authentication system on top of NestJS, TypeORM, react-ssr and Material UI(v4)