Git Product home page Git Product logo

radai.foodfacilities's Introduction

๐Ÿ” Food Facilities Web API

This project is a web API built 100% using .NET 6.0.

The API was made considering the specifications available on Food facilities backend challenge

Running the Web API

Run the Web API using docker-compose

Use docker-compose to run the web API. navigate to /docker and run the command below on Terminal (Linux) or PowerShell (Windows)

docker-compose up

The API will run at the address http://localhost:5000. To make sure it is running correctly, you can access the API swagger at http://localhost:5000/swagger.

If you need to change some variable at /src/RadAI.FoodFacilities.WebAPI/appsettings.json, remember to delete the image foodfacilities-web-api from your Docker, as the image contains a snapshot of this file.

Run the Web API using the command line

If you have dotnet SDK 6.0 installed on your machine, you can run the project from Terminal (Linux) or PowerShell (Windows). Navigate to the directory root and run the commands below:

dotnet build RadAI.FoodFacilities.sln
cd .\src\RadAI.FoodFacilities.WebAPI\
dotnet run

The API will run at the address specified on the application logs. To verify it is running correctly, access the API swagger at http://{{log.address}}/swagger.

Run the Web API using Visual Studio

If you have Visual Studio 2022 installed on your machine, you can run the project directly from it. Open the solution RadAI.FoodFacilities.sln, set the project RadAI.FoodFacilities.WebAPI as the startup project, and run the project.

The API swagger will automatically open on your default browser.


Documentation

Detailed information about what this project is about and the stack used is available at /docs/DOCUMENTATION.md.

Detailed information about the web API endpoints is available at /docs/REQUESTS.md.


Critique

The critique section is available at /docs/CRITIQUE.md


Time spent

It was spent ~ 8 hours developing this solution.


If you have any questions, please contact me by email [email protected].

radai.foodfacilities's People

Watchers

Arthur Soares avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.