Git Product home page Git Product logo

monorepo_boilerplate_typescript_nextjs's Introduction

Cityzen Application

This is a monorepo to eventually house the majority of the core platform.

Packages

  • (WebApp)[packages/webapp] - Next.JS Application for the primary Site.
  • (API)[packages/api] - (Work in progress), common package to allow for importing of api.
  • (Common)[packages/common] - All shared common code. Avoid putting UI here, rather place shared business logic, interfaces, etc...
  • (UI)[packages/ui] - Any shared UI here.

Getting Started

Installation

Note this depends on Yarn - do not use npm **

1.) yarn install or yarn for short.

Quick Tips

  • Adding a local dependency? - yarn add @cityzen/[email protected] (forgetting to tag the version will lead to not found error).
  • Run a script on a particular package, but from root? - yarn workspaces @cityzen/webapp run build
  • Update TS Config Automatically - yarn run update:tsconfig.
  • If you get the error (in webapp), cannot read property 'substring' of undefined - in /packages/webapp run GIT_COMMIT_SHA =$(git rev-parse HEAD).

monorepo_boilerplate_typescript_nextjs's People

Contributors

wkasel avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.