khalidbelk/ts-express-starter
1
0
Fork 0
mirror of https://github.com/khalidbelk/ts-express-starter.git synced 2026-06-21 03:12:50 +02:00
Code Issues Projects Releases Packages Wiki Activity
Fastest way to setup a working Typescript, Node JS and Express project.
5 commits 1 branch 0 tags 29 KiB
  • Shell 91.4%
  • TypeScript 8.6%
Find a file
Exact
khalidbelk 69aa615b3f docs: enhance usage instructions in README
2025-03-02 16:43:13 +01:00
static feat: initial commit 2025-03-02 06:41:53 +01:00
LICENSE feat: initial commit 2025-03-02 06:41:53 +01:00
README.md docs: enhance usage instructions in README 2025-03-02 16:43:13 +01:00
starter.sh fix: fix typos in log messages 2025-03-02 15:16:26 +01:00

README.md

TypeScript & Express Project Quickstart

This script sets up an Express.js with TypeScript project with basic dependencies and working npm scripts to accelerate the setup process.

Usage

  1. Clone the repository :
git clone git@github.com:khalidbelk/ts-express-starter.git
  1. Ensure the script has execution permissions :
sudo chmod +x starter.sh
  1. Run the script :
./starter.sh

This will create a directory named project/ containing the server source files and installed dependencies ready to be launched.

Running the Server

After setup, navigate to the project directory and use one of these commands:

  • Development mode: npm run dev
  • Production mode: npm start

License 📃

This project is licensed under the MIT License - see the LICENSE file for details.