https://github.com/vdegenne/typescript-fullstack-project-starter

https://github.com/vdegenne/typescript-fullstack-project-starter

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/vdegenne/typescript-fullstack-project-starter
• Owner: vdegenne
• Created: 2020-01-15T00:38:19.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T05:13:12.000Z (almost 2 years ago)
• Last Synced: 2023-03-02T00:42:14.987Z (almost 2 years ago)
• Language: JavaScript
• Size: 420 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# typescript-fullstack-project-starter

This package includes the following technos :

- compilation: `typescript`, `rollup`

- server: `pm2`, `es-dev-server`, `koa`

- front: `lit-element`, `@material` elements

## Filesystem

Explanations coming soon.

## Installation/Initialisation

- Installation

  - [x] Clone this repository

    ```bash

    git clone --depth 1 https://github.com/vdegenne/typescript-fullstack-project-starter

    mv typescript-fullstack-project-starter my-app

    cd my-app

    rm -rf .git

    ```

  - [ ] Install the deps `npm i`

  - [ ] Install `pm2` and `es-dev-server` globally.

- Pre-configuration

  - [ ] Update the server options under `src/server/options.ts`

  - [ ] Watch for file changes (required to run the server) `npm run watch`

  - [ ] Modify the app name in `pm2.config.js` & `public/index.html`

  - [ ] Start the server `pm2 start pm2.config.js`

- Development

  - [ ] Watch for file changes `npm run watch`

  - [ ] Add middlewares/routes in `src/server/es-dev-server.config.ts`

  - [ ] Modify back-end and front-end sources under `src`. Everytime a `.ts` file is changed `rollup` will recompile, and the server restart.

  - [ ] Visit `http://localhost:` to see the initial state of your app.

- Further

  - [ ] Delete this `README.md` and replace with the one of your project.