https://github.com/burakys/fastify-example

Fastify URL Shortener example with TypeScript, Swagger and Zod
https://github.com/burakys/fastify-example

api fastify swagger ts typescript url-shortener zod

Last synced: about 1 month ago
JSON representation

Fastify URL Shortener example with TypeScript, Swagger and Zod

• Host: GitHub
• URL: https://github.com/burakys/fastify-example
• Owner: BurakYs
• License: mit
• Created: 2024-05-02T21:50:30.000Z (8 months ago)
• Default Branch: master
• Last Pushed: 2024-12-02T20:11:19.000Z (about 1 month ago)
• Last Synced: 2024-12-02T21:24:47.521Z (about 1 month ago)
• Topics: api, fastify, swagger, ts, typescript, url-shortener, zod
• Language: TypeScript
• Homepage:
• Size: 229 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# 🚀 Fastify Rest API

A simple example of a REST API using Fastify, TypeScript, Zod and Swagger.




## 🏠 Run Locally

```bash 

# 1. Clone the repository:

git clone https://github.com/BurakYs/fastify-example.git

# 2. Go to the project directory:

cd fastify-example

# 3. Install dependencies:

npm install

# 4. Configure the environment variables:

cp .env.template .env

# 5. Edit the configuration files under the `src/config` directory according to your needs.

# 6. Run the project:

npm run dev

```

## 📝 License

This project is licensed under the MIT License. See [LICENSE](./LICENSE) for more information.