From 5409aac37a96f7ea96b177246ea5eedec3334c6f Mon Sep 17 00:00:00 2001 From: Elio Struyf Date: Fri, 14 Jun 2024 21:15:32 +0200 Subject: [PATCH] Added docs --- LICENSE | 21 +++++++++++++++++++++ README.md | 23 +++++++++++++++++++++++ 2 files changed, 44 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..a4a124a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Elio Struyf + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..a998a45 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# Front Matter CMS - API + +This repository contains the API for the Front Matter CMS. The API is built using Azure Functions and Node.js. + +## Getting Started + +To get started, you will need to have the following installed: + +- Node.js +- Azure Functions Core Tools + +## Running the API + +To run the API, you will need to run the following command: + +```bash +npm run watch +func start +``` + +## Examples + +You can test out the API using the [validate HTTP](./validate.http) file. To do this, you will need to have the [REST Client](https://marketplace.visualstudio.com/items?itemName=humao.rest-client) extension installed in Visual Studio Code. \ No newline at end of file