FAST FullStack React with TypeScript starter kit.
If you're using Github, you can click on the "Use this template" button to create a new repository based on this starter kit.
The repo comes with some examples on how to do basic stuff. As this is not really needed in real projects, you can remove them by running:
yarn clean-up-example-code
clone this repository into your own project folder. and start working
git clone https://github.com/gilamran/fullstack-typescript.git <MyProjectName>
cd <MyProjectName>
yarn
yarn 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
tsconfig.json
for client and server.NodeJs 18.12.+
, Chrome 79+
or FireFox 72+
.
├── /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.
├── .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
├── index.js # The server's entry point
├── package.json # The list of 3rd party libraries and utilities
├── README.md # This file
yarn dev
- Client and server are in watch mode with source maps, opens http://localhost:3000
yarn lint
- Runs es-lintyarn build
- dist
folder will include all the needed files, both client (Bundle) and server.yarn start
- Just runs node ./dist/server/server.js
yarn start:prod
- sets NODE_ENV
to production
and then runs node ./dist/server/server.js
. (Bypassing vite)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.
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.