Just clone this repository into your own project folder. and start working
git clone https://github.com/gilamran/fullstack-typescript.git <MyProjectName>
cd <MyProjectName>
npm install
npm run dev
If you want to detach from this repository into your own repository do this:
git remote remove origin
git remote add origin YOUR_REPO_URL
git push -u origin master
- Simple to jump into, Fast because it is simple.
- Separate
tsconfig.json
for client and server. - Client and server can share code (And types). For example: IUserDTO.d.ts
- The client is bundled using Webpack because it goes to the browser.
- The server is emitted by TypeScript because node 6 supports es6.
.
├── /node_modules/ # 3rd-party libraries and utilities
├── /dist/ # All the generated files will go here, and will run from this folder
├── /src/ # The source code of the application
│ ├── /client/ # React app
│ ├── /server/ # Express server app
│ ├── /shared/ # The shared code between the client and the server
├── /assets/ # images, css, jsons etc.
├── .babelrc # babel configuration
├── .eslintrc # es-lint configuration
├── .prettierec # prettier configuration
├── .gitignore # ignored git files and folders
├── .nvmrc # Force nodejs version
├── .env # (ignored) Can be used to override environment variables
├── package.json # The list of 3rd party libraries and utilities
└── tslint.json # TypeScript linting configuration file
├── README.md # This file
- React v16
- React router v4
- Material-ui
- Jest
- Styled Components
- Axios (For Client/Server communication)
npm run dev
- Client and server are in watch mode with source maps, opens http://localhost:3000npm run test
- Runs jest testsnpm run link
- Runs es-lintnpm run build
-dist
folder will include all the needed files, both client (Bundle) and server.npm start
- Just runsnode ./dist/server/server.js
npm start:prod
- setsNODE_ENV
toproduction
and then runsnode ./dist/server/server.js
. (Bypassing webpack proxy)
All applications require a config mechanism, for example, SLACK_API_TOKEN
. Things that you don't want in your git history, you want a different environment to have different value (dev/staging/production). This repo uses the file config.ts
to access all your app variables. And a .env
file to override variable in dev environment. This file is ignored from git.
- Universal (Server side rendering)
- Redux/MobX (State management)
- Node +10.17.0
This code is released as is, under MIT licence. Feel free to use it for free for both commercial and private projects. No warranty provided.