This is the backend API for the NutriHelp project. It is a RESTful API that provides the necessary endpoints for the frontend to interact with the database.
- Open a terminal and navigate to the directory where you want to clone the repository.
- Run the following command to clone the repository:
git clone https://github.com/Gopher-Industries/Nutrihelp-api- Navigate to the project directory:
cd Nutrihelp-api- Install the required dependencies (including python dependencies):
npm install
pip install -r requirements.txt
npm install node-fetch- Contact a project maintainer to get the
.envfile that contains the necessary environment variables and place it in the root of the project directory. - Start the server:
npm startA message should appear in the terminal saying Server running on port 80.
You can now access the API at http://localhost:80.
The API is documented using OpenAPI 3.0, located in index.yaml.
You can view the documentation by navigating to http://localhost:80/api-docs in your browser.
/\ Please refer to the "PatchNotes_VersionControl" file for /
/\ recent updates and changes made through each version. /\