juananmuxed / template-ts-api

Template for API with Node, Express & Sequelize

🌡️ Template TS API

⌨️ with ❤︎ by MuXeD

GitHub Status

Demo deploy status

🎱 Introduction

This is a simple template API REST to get data from game a DB with Express, Sequelize & Node.

☕️ Buy Me a Coffee

🐛 Report a bug

Please follow one of this links to report a bug:

• Github issues
• Discord

💻 Development

To fix bugs or simply check code.

Requirements:

• Install MariaDB (and create a database called template-ts)
• Node 12 at least

Clone the repo

git clone https://github.com/juananmuxed/template-ts-api.git

Access to the folder

cd template-ts-api

Run NPM to install dependencies and run dev environment

cd npm i
cd npm run dev

Clone .env.example or rename as .env

And you can access to the swagger via web browser in http://localhost:3000/swagger

Docker production

Create a .env.production with params of DB and run npm run docker:deploy

Remember you need a Database with a name-of-table table chosen in the .env.production file.

🏗 Built with

• Node
• Express
• Sequelize

📌 Versions

Used SemVer for versions. For all available version, see tags.

And here the Changelog

🍰 Contributing

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests.

📄 License

This project is under license (MIT) - see LICENSE for details.