https://github.com/mikolajszymczuk1/foodawesomeclient

Recipes app (Client)
https://github.com/mikolajszymczuk1/foodawesomeclient

List: foodawesomeclient

api-rest food recipes router teamwork typescript vanilla-js webdevelopment

Last synced: 4 days ago
JSON representation

Recipes app (Client)

• Host: GitHub
• URL: https://github.com/mikolajszymczuk1/foodawesomeclient
• Owner: mikolajszymczuk1
• Created: 2022-09-07T19:01:36.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-19T15:04:57.000Z (over 1 year ago)
• Last Synced: 2024-04-28T06:27:42.400Z (7 months ago)
• Topics: api-rest, food, recipes, router, teamwork, typescript, vanilla-js, webdevelopment
• Language: SCSS
• Homepage: https://coruscating-starship-b49286.netlify.app/
• Size: 1.66 MB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Food Awesome Client

Food Awesome is a simple recipe app where you can store/create/share your recipes. 


``` !!! This project is a client app only and need working backend that serve api for client !!! ```

## 🚀 Project setup

---

Install all project packages:

```

npm install

```

Run dev server:

```

npm run watch

```

Run tests:

Unit

```

```

E2E

```

```

To build project

```

npm run build

```

or

```

npm run build:dev

```

or

```

npm run build:prod

```

## Preferred api for client (FoodAwesomeClient API v1)

| Method | Endpoint | Parameters | Data | Description |

|--------|----------|------------|------|-------------|

| GET | /api/recipes/random | null | null | Return random recipe from database |

| GET | /api/recipes | null | null | Return all created recipes from database |

| GET | /api/recipes/id | ( Integer ) id | | Return recipe with specific id |

| GET | /api/recipes/stats | null | null | Return some statistic information like 'Number of created recipes' |

| POST | /api/recipes/ | null | token, new recipe data | Create new recipe

| PUT | /api/recipes/id | ( Integer ) id | token, updated recipe data | Update recipe

| DELETE | /api/recipes/id | ( Integer ) id | token | Delete recipe

| GET | /api/recipes/id/details | (Integer) id | null | Return details about recipe with specific id |

| POST | /auth/login | null | login, password | Log in user to service and return special secret token for user |

| POST | /auth/register | null | login, email, password, repeat password | Create new user record in database (Add new user)

| POST | /users/id/recipes | ( Integer ) id | token | Returns the user's recipes with the specified id |