diff options
| -rw-r--r-- | LICENSE | 21 | ||||
| -rw-r--r-- | README.md | 45 |
2 files changed, 66 insertions, 0 deletions
@@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 Saumit Dinesan + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4ab0c58 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Golang Backend API using Echo for FSI(File System Integrity) Application +Developing a simple Golang backend API using the [Echo framework](https://github.com/labstack/echo). This API stores IDs and their corresponding hashes in a SQL server and provides functionality to verify if a given hash matches the stored hash for a specific ID, thereby providing integrity service that aligns with the CIA (Confidentiality, Integrity, Availability) triad for data security. + +## Getting Started + +To get started with this project, follow these steps: + +### Prerequisites + +- Go installed on your machine. +- A SQL database server to store IDs and hashes. + +### Installation + +1. Clone this repository to your local machine: + + ```bash + git clone https://github.com/justsaumit/go-fsi-api.git + cd go-fsi-api + ``` + +2. Initialize and install project dependencies using Go modules: + + ```bash + go mod vendor + ``` + +3. Create a configuration file (e.g., config.yaml) to specify your database settings and other configurations. + +4. Run the server: + + ```bash + go run main.go + ``` + +### Usage + +Once the server is running, you can access the API endpoints to add file hashes and verify them. + +- To add a file hash, make a POST request to `/add` with JSON data containing the ID and hash. +- To verify a file hash, make a POST request to `/verify` with JSON data containing the ID and hash. + +## License + +This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |