Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mmraisi/fastify-oas-app
Todo application built with Fastify, utilizing oas-fastify for OpenAPI specification 3.0.0 documentation and validation.
https://github.com/mmraisi/fastify-oas-app
fastify openapi-specification
Last synced: 3 months ago
JSON representation
Todo application built with Fastify, utilizing oas-fastify for OpenAPI specification 3.0.0 documentation and validation.
- Host: GitHub
- URL: https://github.com/mmraisi/fastify-oas-app
- Owner: mmraisi
- License: mit
- Created: 2024-03-15T04:04:28.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-06-26T14:17:31.000Z (7 months ago)
- Last Synced: 2024-10-14T05:03:18.668Z (3 months ago)
- Topics: fastify, openapi-specification
- Language: TypeScript
- Homepage:
- Size: 737 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fastify Todo App
This is a simple Todo application built with Fastify, utilizing oas-fastify for OpenAPI specification 3.0.0 documentation and validation.
## Installation
1. Clone the repository:
```bash
git clone
```
2. Install dependencies:
```bash
cd
make install
```
## Usage
To start the server using Docker Compose, make sure you have Docker installed on your machine. Then, navigate to the project directory and run the following command:
```bash
make start
```
> The server will be running on port 8080 by default
To stop the server and remove the containers, use the following command:
```bash
make stop
```
To clean up the project by removing running containers, volumes, node_modules, coverage, src/openapi.json, and dist, use the following command:
```
make clean
```
## API Documentation
To run the docs server:
> [!NOTE]
> THE `make start` will run both the server and docs, to run the docs image alone, use the following command
```
make docs
```
You can access the OpenAPI documentation for the API at [http://localhost:8000](http://localhost:8000). This documentation provides detailed information about the available endpoints, request parameters, responses, and schemas.
## Contributing
Contributions are welcome! Feel free to open issues or pull requests.
## License
[MIT License](LICENSE)