The project is a framework for creating RESTful APIs using Node.js and Fastify, written in TypeScript for safer and more scalable development. With this framework, you can quickly create a RESTful API that is easy to maintain and customize. Additionally, with the help of Fastify, your API will have excellent performance, ensuring a smooth and fast user experience.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them.
A step by step series of examples that tell you how to get a development env running.
- Clone the repository with the command
git clone https://github.com/pxnditxyr/botyrest.git- Run the command
npm i- Change name of .env.example to .env
mv .env.example .env
For running database you need
docker compose up -dFor running the application in development mode, it's recommended to have two separate terminal windows running the following commands:
- To transpile TypeScript files in watch mode.
npm run build:dev- To start the development server with file watch.
npm run start:devFor running the application in production mode, run the command To start the production server.
- To transpile TypeScript files.
npm run build:prod- To start the server.
npm run start:prod- Pxndxs - Link to GitHub profile
This project is licensed under the MIT License - see the LICENSE.md file for details.
- Thank you to my 10 cats for keeping me company while coding.