Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leonardospereira/daily-diet-api
An API written with TypeScript and NodeJS to help you to control your daily diet
https://github.com/leonardospereira/daily-diet-api
fastify knex nodejs sqlite typescript zod
Last synced: about 2 months ago
JSON representation
An API written with TypeScript and NodeJS to help you to control your daily diet
- Host: GitHub
- URL: https://github.com/leonardospereira/daily-diet-api
- Owner: LeonardoSPereira
- Created: 2024-04-11T13:10:23.000Z (9 months ago)
- Default Branch: master
- Last Pushed: 2024-09-11T20:43:27.000Z (3 months ago)
- Last Synced: 2024-09-12T07:04:25.811Z (3 months ago)
- Topics: fastify, knex, nodejs, sqlite, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 198 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Daily Diet API
## Table of Contents
- [About](#about)
- [Getting Started](#getting_started)
- [Usage](#usage)
- [Routes](#routes)
- [Tests](#tests)
- [Technologies](#technologies)
This is a RESTful API built in with NodeJS, that allows users to track their daily diet.
The API allows users to create an account and based on a cookie session, the user can track their daily diet.
The user can realize CRUD operations on their daily diet, and also can track their metrics, like total meals, total meals on diet, total meals off diet and their best sequence of meals on diet.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
### Prerequisites
You will need to have NodeJS installed on your machine. You can download it [here](https://nodejs.org/en/download/).
You will also need an package manager, like npm or pnpm. NPM comes with NodeJS installation, and you can install pnpm by running the following command:
```bash
npm install -g pnpm
```
In this project I'm using PNPM. You can use NPM or Yarn if you want.
### Installing
A step by step series of examples that tell you how to get a development env running.
1. Clone the repository or download the zip file.
if you will use git, you will also need to have git installed on your machine. You can download it [here](https://git-scm.com/downloads).
```bash
git clone https://github.com/LeonardoSPereira/Daily-Diet-API.git
```
2. Install the dependencies
```bash
pnpm install
```
3. Create a .env file in the root of the project and add the following variables:
```env
PORT=3000
```
4. Run the migrations
```bash
pnpm knex migrate:latest
```
5. Start the server
```bash
pnpm dev
```
## Routes
The API has the following routes:
### Users
#### Create a user
```http
POST /users
```
- Body
```json
{
"name": "John Doe",
"email": "[email protected]"
}
```
**Remember to get the cookie send as a response for this route. You will need to send it in the following requests. The cookie can be found in the response header.**
### Meals
#### Create a meal
```http
POST /meals
```
- Body
```json
{
"name": "your meal name",
"description": "your meal description",
"is_meal_on_diet": false,
"meal_day": "day of the meal",
"meal_time": "time of the meal"
}
```
#### Get all meals
```http
GET /meals
```
#### Get a meal
```http
GET /meals/:id
```
- Params
```json
{
"id": "meal id"
}
```
#### Update a meal
```http
PUT /meals/:id
```
- Params
```json
{
"id": "meal id"
}
```
- Body
```json
{
"name": "your meal name",
"description": "your meal description",
"is_meal_on_diet": true,
"meal_day": "day of the meal",
"meal_time": "time of the meal"
}
```
**You can send only the fields you want to update.**
#### Delete a meal
```http
DELETE /meals/:id
```
- Params
```json
{
"id": "meal id"
}
```
### Metrics
```http
GET /metrics
```
## Usage
Having the API running, you can use a tool like Postman to make requests to the API.
The routes are described above, with the body and params that you need to send in the requests.
***Remember to send the cookie in the requests that need it.***
## Tests
The app has tests for create a user, create a meal, get all meals and get a meal.
The tests where written using Vitest and Supertest.
To run the tests, you can run the following command:
```bash
pnpm test
```
## Technologies
- [TypeScript](https://www.typescriptlang.org/)
- [NodeJS](https://nodejs.org/en/)
- [Fastify](https://www.fastify.io/)
- [Knex](http://knexjs.org/)
- [SQLite](https://www.sqlite.org/index.html)
- [Zod](https://zod.dev)
- [Vitest](https://vitest.dev)