create-express-ts-api v1.2.0
[](./LICENSE) [](https://www.npmjs.com/package/create-express-ts-api)
Getting Started
Follow the instructions to initialize your express-ts-api project using this starter kit:
Prerequisites
Install NodeJS LTS
npm
npm install npm@latest -g
Initializing the project
Initiate your project by using the following npm command:
npx create-express-ts-api <project-name>
example :
npx create-express-ts-api Firstapi
Install NPM packages
npm install
After this follow the steps to setup the Development DB:
Setting up Development DB
Note If facing any issues, feel free to raise a issue or head towards Contact section
Start the server by running the following command
npm run dev
Tech Stack Used
Setting up Development DB
To setup the DB follow the steps: 1. To set up the development DB make sure you have docker and docker-compose installed in your system.
- Add a .env file at the root of the project and add a Database URL in the file
PORT=3000
DATABASE_URL="postgresql://johndoe:randompassword@localhost:5432/mydb"
To Trigger the Development DB Setup run following commands
npm run dev:db
npm run db-generate
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Refer to this Contribution.md if you have any difficulty in making a pull request
License
Distributed under the MIT License. See LICENCE
for more information.
Contact
Sarthak Jain - @sarthakjdev
Email Id : contact.sarthakjain@gmail.com
Discord : Sarthak Jain#2443
LinkedIn: LinkedIn
Documentation
To know more details about it refer to the blog: Hashnode