cdoru / ark Goto Github PK

View Code? Open in Web Editor NEW

This project forked from saltyshiomix/ark

0.0 2.0 0.0 237 KB

An easiest web app template on top of nest, TypeORM, Next.js and Material UI.

License: MIT License

TypeScript 99.81% JavaScript 0.19%

ark's Introduction

An easiest web app template on top of nest, TypeORM, Next.js and Material UI.

Features

Database synchronization with entities - powered by TypeORM
Server Side Rendering - powered by Next.js
API server - powered by nest
User authentication - powered by Passport
Material UI design
Environment viriables using dotenv

Technologies

Lang
- TypeScript - Javascript that scales
Database
- PostgreSQL - The World's Most Advanced Open Source Relational Database
ORM (Object-relational mapping)
- TypeORM - ORM for TypeScript and JavaScript (ES7, ES6, ES5)
Server
- nest - A progressive Node.js framework for building efficient, reliable and scalable server-side applications
  - internally using Express - Fast, unopinionated, minimalist web framework for Node.js
- Next.js - The React Framework
Environment variables
- dotenv - Loads environment variables from .env for nodejs projects
User authentication
- Passport - Simple, unobtrusive authentication for Node.js
UI framework
- React - A JavaScript library for building user interfaces
- Next.js - The React Framework
- Material UI - React components that implement Google's Material Design.

Setup

# install database (postgresql)
$ brew install postgresql

# if you want to start postgresql in startup, try do this
$ brew services start postgresql

# create user "arkuser" with password "arkark"
$ createuser -P arkuser

# create database "arkdb" owened by "arkuser"
$ createdb arkdb -O arkuser

# install dependencies
$ yarn

# development mode
# please make sure to create the `.env` file!
$ yarn dev

# production mode
# please make sure to create the `.next/.env` file!
$ yarn build
$ yarn start