-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #126 from preciousBlessed/optimizeBee
Optimize readme
- Loading branch information
Showing
1 changed file
with
150 additions
and
79 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,79 +1,150 @@ | ||
| # lightning-food | ||
|
|
||
| ## Free Lunch App | ||
|
|
||
| ### Functionalities | ||
|
|
||
| Design Pattern | ||
| REST API | ||
| Model, Controller | ||
|
|
||
| ### Technologies and Framework | ||
|
|
||
| - Database - MySQL | ||
| - Dependencies - express.js, Node.js, sequelize, es-lint, prettier, dotenv, JWT | ||
| - Authentication: password | ||
| - Model: Link to model | ||
| - Repo Link | ||
|
|
||
| ### System Components | ||
|
|
||
| - Authentication and Authorization | ||
| - Models: users, organization | ||
| - Middleware: authentication | ||
| - Controllers: userLoginController, userRegisterationController, userLogoutController, changePasswordController, | ||
| emailConfirmationController, codeConfirmationController | ||
|
|
||
| ### API Endpoints: | ||
|
|
||
| - POST /api/auth/login - Login a user { staff or Organisation } | ||
| - POST /api/auth/signup/org-user - Register admin user and organisation | ||
| - POST /api/auth/signup - Register user | ||
| - POST /api/auth/logout - Logout a user | ||
| - PATCH /api/user - Forgot password | ||
| - POST /api/emailConfirmation - sends code to email | ||
| - POST /api/codeConfirmation - verifies authenticity of the code | ||
|
|
||
| ### User Management | ||
|
|
||
| - Models: organisation_invites, organisation_lunch_wallet | ||
| - Middleware: is_admin, authentication | ||
| - Controllers: updateUserController, getOneUserController, getAllUserController, sendUserInviteController | ||
|
|
||
| ### API Endpoints: | ||
|
|
||
| - GET /api/users/me - Get current user/staff details | ||
| - GET /api/users/:id - Get a user/staff details using ID | ||
| - GET /api/users - List of all users | ||
| - PATCH /api/users/:id - Update user details | ||
| - DELETE /api/users/:id - Delete user - ADMIN | ||
| - POST /api/invite - send user to invite – ADMIN | ||
|
|
||
| ### Lunch Management | ||
|
|
||
| - Models: withdrawals, lunches | ||
| - Middleware: authentication | ||
| - Controllers: getAllLunchController, getAllNotificationController, getLunchByIDController, giftLunchController, redeemGiftController | ||
|
|
||
| ### API Endpoints: | ||
|
|
||
| - GET /notification - Get all notifications | ||
| - GET /lunch/:userId - Get lunch details using user ID | ||
| - GET /lunch/:lunchId - Get lunch details using ID | ||
| - GET /lunch - Get all lunch history | ||
| - POST /send - Give lunch to a user | ||
| - POST /redeem - Redeem a lunch | ||
|
|
||
| ## API Testing | ||
|
|
||
| ## Video Volunteer | ||
|
|
||
| ### ToDo Actions | ||
|
|
||
| - Create a Database: ExtranoDev, Aanuoluwapo Liasu | ||
| - Create a Folder structure: Precious Chukwuezi | ||
| - Create API documentation: | ||
| - Functionality | ||
| - Api Request Information | ||
| - Request and Response format | ||
| - API Testing teams: creating postman file | ||
| # Free Lunch App | ||
| A NodeJS-MYSQL based application design by Team-Lightning in the HNG-X Internship, September 2023 | ||
|
|
||
| ### Overview | ||
| Click and navigate to any section of your choice. | ||
|
|
||
| - [Getting Started💡](#getting-started) | ||
| - [API Documentation Summary💡](#api-documentation-summary) | ||
| - [Environmental Variables](#environmental-variables) | ||
| - [Major Packages and Dependencies](#major-packages-and-dependencies) | ||
| - [Contributors](#contributors) | ||
|
|
||
| ## Getting Started | ||
|
|
||
| Create an organization, invite your staff and allow them gift free lunch to one another. This project is intended to serve as Stage-3 task for the HNG-X internship program. This application basically exploits the functionalities of a `REST` architecture and the `MySQL` Relational Database. There are two major types of `users` in this app: | ||
| - An Admin-User | ||
| - A Normal-User | ||
|
|
||
| To begin, an `admin-user` first signs up and creates an organization. The admin will then send invites to staff members (`normal-user`) and after verification, each staff will need to create an account with the organization name and carry out further operations under the umbrella of that organization. A `normal-user` cannot be registered and/or use the application unless an invite has been received and verified from the organization under which the user intends to register. Only the `admin-user` has privileges of performing full `CRUD` operations on all users in his organization. | ||
|
|
||
| The two major actions in this application is: | ||
| - Gifting a lunch | ||
| - Redeeming a lunch | ||
|
|
||
| A user can `gift` a free lunch from the organization's collection to another user. The other user is then left with the option to `redeem` the lunch. By redeeming the lunch, he can withdraw the corresponding amount of the lunch to his/her bank account. | ||
|
|
||
| Multiple organizations can be hosted on this application. It is like a social-media hub for gifting free lunch. Explore more about this app below. | ||
|
|
||
| ## API Documentation Summary | ||
| The `REST API` architecture of this application is implemented using `Node-js` and `Express`. | ||
| This API is equipped with functionalities to dynamically handle request/responses on various endpoints/resources of this application. To access some endpoint/resource, a user might be required to have a form of authentication and authorization which is implemented by consuming the vast functionalities of `Jason Web Tokens` (JWT). The key `API` endpoint set-up is explained in the titles below: | ||
|
|
||
| - [Endpoint Consumption Summary Table](#endpoint-consumption-summary-table) | ||
| -[ Request Methods Response Formats and Status Codes Used](#request-methods-response-formats-and-status-codes-used) | ||
| - [Models, ERD and Database SetUp](#models,-erd-and-database-setup) | ||
| - [Simple Setup Instructions](#simple-setup-instructions) | ||
| - [Sample API Usage](#sample-api-usage) | ||
|
|
||
| ### Endpoint Consumption Summary Table | ||
|
|
||
| |s/n| Name of Endpoint | Endpoint Link | Endpoint Method | Endpoint Description | Access | | ||
| |:--|:---------------- |:-------------:|:---------------:|:----------- |:---------------:| | ||
| | | |_**Authentication Routes**_ (`/api/auth`)|| | ||
| |1.| Create/Sign-up Organization-User | `/api/auth/signup/org-user` | `POST` | Creates organization account | _Admin_ | | ||
| |2.| Create/Sign-up User | `/api/auth/signup` | `POST` |Creates a user account| _Admin/User_| | ||
| |3.| Login User | `/api/auth/login` | `POST` | Logs in a user (admin allowed)| _Admin/User_| | ||
| |4.| Logout User | `/api/auth/logout` | `POST` |Logs out a user out| _Admin/User_| | ||
| | | |_**User Routes -CRUD**_ (`/api/users`)|| | ||
| |5.| Get Me | `/api/users/me` | `GET` |Fetches a user profile| _Admin/User_ | | ||
| |6.| Get User by id | `/api/users/:id` | `GET` |Finds a user by id| _Admin/User_ | | ||
| |7.| Get All Users | `/api/users/` | `GET` |Finds all users for an organization| _Admin_ | | ||
| |8.| Update User | `/api/user/:id` | `PUT` |Updates a user by id| _Admin/User_ | | ||
| |9.| Delete User| `/api/users/:id` | `DELETE` |Deletes a user| _Admin/User_ | | ||
| |10.| Logout User | `/api/auth/logout` | `POST` |For loggin a user out| _Admin/User_ | | ||
| | | |_**Organization Routes**_ (`/api/organization`)|| | ||
| |11.| Create Organization| `/api/organization/create`| `POST`| Creates new organization | _Admin_ | | ||
| |12.| Confirm Invite | `/api/organization/confirm-invite` | `POST`| Confirms invite to an org. | _Admin_ | | ||
| |13.| Send Invite | `/api/organization/send-invite` | `POST`| Sends user an invite to join org. | _Admin_ | | ||
| |14.| Update Organization | `/api/organization/update-info` | `PUT`| Updates the organization details | _Admin_ | | ||
| | | |_**Lunch Routes**_ (`/api/lunch`)|| | ||
| |15.| Get All Lunch | `/api/lunch/` | `GET`| Fetches all available lunch | _Admin/User_ | | ||
| |16.| Gift Lunch | `/api/lunch/send/:id` | `POST`| Send lunch to a user by id | _Admin/User_ | | ||
| |17.| Get Lunch Detail | `/api/lunch/:lunchId` | `GET`| Fetches details for a lunch by id | _Admin/User_ | | ||
| |18.| Get Lunch by UserID | `/api/lunch/user/:userId` | `GET`| Fetches lunch for a user by id | _Admin/User_ | | ||
| | | |_**Withdrawal[Redeem] Routes**_ (`/api/withdrawals`)|| | ||
| |19.| Redeem Lunch | `/api/withdrawals/withdraw` | `POST`| withdraws the monetary value for a lunch | _Admin/User_ | | ||
| |20.| Withdrawal History | `/api/withdrawals/history` | `GET`| withdraws the monetary value for a lunch | _Admin/User_ | | ||
|
|
||
| ### Request Methods Response Formats and Status Codes Used | ||
|
|
||
| |S/N | Request Methods | Description | | ||
| |:---|:---------------:|:------------| | ||
| |1. | `GET` | Fetch item(s) | | ||
| |2. | `POST` | Send item(s) | | ||
| |3. | `PUT` | Update item(s) | | ||
| |4. | `DELETE` | Remove or Delete item(s) | | ||
|
|
||
| |S/N | Status Code | Description | | ||
| |:---|:---------------:|:------------| | ||
| |1. | `200` | `OK` | | ||
| |2. | `201` | `CREATED` | | ||
| |3. | `400` | `BAD REQUEST` | | ||
| |4. | `401` | `UNAUTHORIZED` | | ||
| |5. | `403` | `FORBIDDEN` | | ||
| |6. | `404` | `NOT FOUND` | | ||
| |7. | `500` | `INTERNAL SERVER ERROR` | | ||
|
|
||
| Responses are all sent frontend in `JSON` format for each request. | ||
|
|
||
| ### Models, ERD and Database SetUp | ||
| The database this `API` interfaces with is `MYSQL`. Visit this [link](https://drawsql.app/teams/benrobo/diagrams/free-lunch) to access our models and ERD format | ||
|
|
||
| ### Simple Setup Instructions | ||
| To begin to test this application, first clone the directory where the `app.js` file resides. | ||
| ``` | ||
| git clone url | ||
| ``` | ||
| After cloning the directory, install the dependencies on your local system using the command: | ||
| ``` | ||
| npm install | ||
| ``` | ||
| The package dependencies and dev dependencies will now be installed in your local environment. Run the command to start the application: | ||
| ``` | ||
| nodemon app.js | ||
| ``` | ||
| The application starts running and listening on the port defined in `process.env.PORT`. A message will be printed on the console to show that your app is running and has connected to the database. You can access the `MYSQL` database from the `CLI`, on a hosted cloud platform or any `MYSQL` server such as the one provided by `MYSQL` workbench. | ||
|
|
||
| ### Sample API Usage | ||
| Visit this [link](url) to view more about the `API` on `Swagger.io` | ||
|
|
||
| ## Environmental Variables | ||
| For effectively testing the API, these credentials were setup in the `.env` file in the root of the repo: | ||
| ``` | ||
| `MYSQL_ADDON_HOST=bfjkcttl9owdewhqjpjf-mysql.services.clever-cloud.com` | ||
| `MYSQL_ADDON_DB=bfjkcttl9owdewhqjpjf` | ||
| `MYSQL_ADDON_USER=uzq1wq0wnpsg6cvu` | ||
| `MYSQL_ADDON_PORT=3306` | ||
| `MYSQL_ADDON_PASSWORD=2PcRLWSJAxvJhbWX2ZNr` | ||
| `MYSQL_ADDON_URI=mysql://uzq1wq0wnpsg6cvu:2PcRLWSJAxvJhbWX2ZNr@bfjkcttl9owdewhqjpjf-mysql.services.clever-cloud.com:3306/bfjkcttl9owdewhqjpjf` | ||
| `JWT_SIGNATURE= *QSJfus1TOH2fSHw41Ifo0LMN2fzeQD*` | ||
| ``` | ||
|
|
||
| ### Major Packages and Dependencies | ||
| - `dotenv` | ||
| - `express` | ||
| - `nodemon` | ||
| - `nodemon` | ||
| - `sequelize` | ||
| - `helmet` | ||
| - `jsonwebtoken` | ||
| - `bcrypt` | ||
| - `http-errors` | ||
| - `husky` | ||
| - `morgan` | ||
| - `mysql2` | ||
| - `nodemailer` | ||
|
|
||
| See more `dev-dependencies` in the [`package.json`](package.json) file. | ||
|
|
||
| ## Contributors | ||
| @ Team Panther, September 2023 | ||
| [Move back up](#free-lunch-app) | ||
|
|
||
|
|
||
| ## Todos | ||
| - Update User endpoints (reset -password) | ||
| - Populate full list of contributors | ||
| - Issues | ||
| - Liscences | ||
| - etc from mentors recommendations... |