This project uses the following technologies:
- Node.js: JavaScript runtime built on Chrome's V8 JavaScript engine.
- Express.js: Web application framework for Node.js.
- TypeScript: Superset of JavaScript which primarily provides optional static typing, classes, and interfaces.
- MySQL: Open-source relational database management system.
- MySQL2: MySQL client for Node.js with focus on performance.
- Zod: TypeScript-first schema declaration and validation library.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
You will need to have Node.js, NPM, and MySQL installed on your machine.
- Clone the repository:
git clone https://github.com/yourusername/yourrepository.git
- Navigate into the directory:
cd yourrepository
- Install dependencies:
npm install
- Run in terminal for database in docker container:
docker-compose up -d
- Run the server:
npm start
Your server will now be running at: http://localhost:{port}.
ENV:
sudo systemctl start FunktoonAPI.service
sudo systemctl daemon-reload