Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lzhudson/daily-diet-api
The daily diet API is a project that consists of an API for controlling user meals.
https://github.com/lzhudson/daily-diet-api
api api-client api-rest fastify insomnia knex node nodejs sql sqlite typescript zod
Last synced: 10 days ago
JSON representation
The daily diet API is a project that consists of an API for controlling user meals.
- Host: GitHub
- URL: https://github.com/lzhudson/daily-diet-api
- Owner: lzhudson
- License: mit
- Created: 2024-07-30T11:12:19.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-31T13:02:24.000Z (4 months ago)
- Last Synced: 2024-10-12T02:42:08.357Z (about 1 month ago)
- Topics: api, api-client, api-rest, fastify, insomnia, knex, node, nodejs, sql, sqlite, typescript, zod
- Language: TypeScript
- Homepage:
- Size: 109 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/lzhudson)
[](#)
[](https://github.com/lzhudson/daily-diet-api/stargazers)
[](https://github.com/lzhudson/daily-diet-api/network/members)
[](https://github.com/lzhudson/daily-diet-api/graphs/contributors)
# :pushpin: Table of Contents
* [Overview](#memo-overview)
* [Features](#rocket-features)
* [Installation](#construction_worker-installation)
* [Testing](#test_tube-testing)
* [Found a bug? Missing a specific feature?](#bug-issues)
* [Contributing](#tada-contributing)
* [License](#closed_book-license)
# :memo: Overview
The daily diet API is an API developed for recording and controlling meals where the user can record their daily meals with name, description, date and time and also whether or not it is within their diet.
# :rocket: Features
* Create user
* Identify each user's meals
* Create, update, delete, list all and list exclusive meal(s) by id
* Provide metrics for the number of meals, the number of meals within the diet, the number of meals outside the diet and the best sequence of meals within the diet.
* e2e tests
# :construction_worker: Installation
**You need to install [Node.js](https://nodejs.org/en/download/) and [Yarn](https://yarnpkg.com/) first, then in order to clone the project via HTTPS, run this command:**
```
git clone https://github.com/lzhudson/daily-diet-api.git
```
SSH URLs provide access to a Git repository via SSH, a secure protocol. If you have a SSH key registered in your Github account, clone the project using this command:
```
git clone [email protected]:lzhudson/daily-diet-api.git
```
**Create the .env file with following content:**
```
NODE_ENV=development
DATABASE_CLIENT=sqlite3
DATABASE_URL="./db/app.db"
```
**Install dependencies**
```
npm i install
```
**Start development server**
```
npm run dev
```
**The routes to test the API are available on the button below:**
Click to Download Insomnia file API
# :test_tube: Testing
**Create the .env.test file with following content:**
```
NODE_ENV=test
DATABASE_CLIENT=sqlite3
DATABASE_URL="./db/test.db"
```
**Running tests**
```
npm run test:all
```
# :bug: Issues
Feel free to **file a new issue** with a respective title and description on the [Daily Diet API](https://github.com/lzhudson/daily-diet-api/issues) repository. If you already found a solution to your problem, **I would love to review your pull request**! Have a look at our [contribution guidelines](https://github.com/lzhudson/daily-diet-api/blob/main/CONTRIBUTING.md) to find out about the coding standards.
# :tada: Contributing
Check out the [contributing](https://github.com/lzhudson/daily-diet-api/blob/main/CONTRIBUTING.md) page to see the best places to file issues, start discussions and begin contributing.
# :closed_book: License
Released in 2024
This project is under the [MIT license](https://github.com/lzhudson/daily-diet-api/main/LICENSE).
Designed by [Rockeseat](https://github.com/Rocketseat) and developed by [Hudson Holanda](https://github.com/lzhudson) 🖤🚀