Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/telattar/simply-cafe

Simple coffeeshop management system backend application using nodejs express and mongodb. Includes integration tests and jsDocs.
https://github.com/telattar/simply-cafe

express jest jwt-authentication mongodb mongoose nodejs supertest

Last synced: 9 days ago
JSON representation

Simple coffeeshop management system backend application using nodejs express and mongodb. Includes integration tests and jsDocs.

Host: GitHub
URL: https://github.com/telattar/simply-cafe
Owner: telattar
License: mit
Created: 2024-06-20T21:16:43.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-08-02T13:26:39.000Z (4 months ago)
Last Synced: 2024-08-02T15:05:37.779Z (4 months ago)
Topics: express, jest, jwt-authentication, mongodb, mongoose, nodejs, supertest
Language: JavaScript
Homepage:
Size: 462 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Simply Cafe ☕

A simple server-side application of a coffeeshop management system. This project demonstrates the implementation of various backend functionalities including user authentication, product management, and order processing.

Prepare a cup of coffee, before you read the rest of this file 😄.

## Tech Used

![Node.js](https://img.shields.io/badge/Node%20js-339933?style=for-the-badge&logo=nodedotjs&logoColor=white)

![Express.js](https://img.shields.io/badge/Express%20js-000000?style=for-the-badge&logo=express&logoColor=white)

![MongoDB](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)

![Jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white)

![JWT](https://img.shields.io/badge/JWT-000000?style=for-the-badge&logo=JSON%20web%20tokens&logoColor=white)

## Features

#### User Authentication 

Secure user registration and login functionality. **How?**

- [Bcrypt](https://www.npmjs.com/package/bcrypt) is used to salt and hash the password during signup instead of using other encryption techniques.

- Each authenticated user is given a signed JWT token at login.

- User roles are checked at each endpoint to make sure users are **authorized** to do a specific action.

#### Product Management and Order Processing

CRUD operations for managing coffee shop products and handling customer orders, including order creation, updating, and deletion. Please refer to the API Endpoints section for more information.

#### Integration Testing

Comprehensive tests using Jest and Supertest. 

## API Endpoints Summary

For input/output details, refer to the description embedded above each function in any file inside the `controller` directiory.

| Endpoint 
|------------------- 
| /login 
| /signUp 
| /logout 
| /item/createItem 
| /item/getItem 
| /item/updateItem 
| /item/deleteItem 
| /bundle/createBundle 
| /bundle/getBundle 
| /bundle/updateBundle 
| /bundle/deleteBundle 
| /menu/addToMenu 
| /menu/getMenu 
| /menu/updateStock 
| /menu/removeFromMenu 
| /order/newOrder 
| /order/viewMyOrder 
| /order/cancelOrder 
| /order/completeOrder

| Method | Description                                    | --------|--------|------------------------------------------------| | POST   | Logs in an existing user                       | | POST   | Registers a new user                           | | POST   | Logs out the currently logged-in user          | | POST   | Creates a new item                             | | GET    | Retrieves details of a specific item           | | PATCH  | Updates details of a specific item             | | DELETE | Deletes a specific item                        | | POST   | Creates a new bundle                           | | GET    | Retrieves details of a specific bundle         | | PATCH  | Updates details of a specific bundle           | | DELETE | Deletes a specific bundle                      | | POST   | Adds an item or bundle to the menu             | | GET    | Retrieves the entire menu                      | | PATCH  | Updates stock of an item or bundle in the menu | | DELETE | Removes an item or bundle from the menu         | | POST   | Creates a new order                            | | GET    | Retrieves details of a customer's order        | | PATCH  | Cancels a customer's order                     | | PATCH  | Marks an order as complete                     |

## Installation

1. **Clone the repository**:

    ```bash

    git clone https://github.com/telattar/simply-cafe.git

    cd simply-cafe

    ```

2. **Install dependencies**:

    ```bash

    npm install

    ```

3. **Set up environment variables**:

    Create a `.env` file in the root directory and add the variables provided in the `.env.sample` file. More details in the file itself.

5. **Run the application**: please make sure your terminal is at `src` directory.

    ```bash

    nodemon index

    ```

6. **Run tests**: please make sure your terminal is at `src` directory. 

    ```bash

    npx jest --node-options=--experimental-vm-modules --detectOpenHandles --verbose src/tests/TESTFILENAME.js

    ```

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

For any questions or feedback, please contact:

**Tarteel Elattar**

[GitHub](https://github.com/telattar)

[Email](mailto:[email protected])