Skip to content

Latest commit

 

History

History
286 lines (206 loc) · 7.49 KB

README.md

File metadata and controls

286 lines (206 loc) · 7.49 KB
Raw

petmall

Online pet marketing made easy online.

This is a full stack application for buying and setting pets online.

logo

petmall is a multi-repo project that contains the following packages

- api
- mobile
- web
  • api - this is the backend server where the database and storage logic is handled.
  • mobile - this is a react-native client consuming the graphql api.
  • web - this is a web application client built with react.js and is consuming the graphql api.

App Mind

In this section I will demonstrate the logic behind my application which can be visualized as follows.

                        |----------> [messages] ------> [user]
                        |
      |------------> [chats]-------> [pet] ------> [seller]
      |
      |
      |------------> [notifications]
      |
      |             |---------> [reaction] ------> [user]
      |             |
[user/seller]  -> [pet] ------> [comment] -------------> [reaction] -----> [user]
                    |       |        |
                    |       |        |------> [comment] -----> [reaction] ---> [user]
  [location] <------|       |                     |
                            |                     |---------> [user]
                            |--------> [user]

  • It all starts with the user or seller

    • anyone who created an account with petmall can buy and sell pets.
    • the user can have access to his/her notifications which are triggered when someone in the app:
      • react to your pet
      • react to your comment
      • commented to your pet
      • reply to your comment on a pet
    • real time messages are the part of this app. The chat models allows buyers and sellers of pets to chat privately. and each chat will be modeled with
      • messages
      • pet
    • The user/seller of the pet can edit pet details and even mark the pet as sold if the pet is sold.
    • an authenticated seller or buyer will have access to the notifications and messages and a profile.
    • In the profile the user can do the following:
      • edit profile details
      • signing out of the app
      • delete their account
      • change account password

  • pet model contains the following

    • location of the pet
    • reactions to the pet by others
    • comments / reviews of the pets by others

Output

In this section wi will show the screenshot of the petmall app for both the web and mobile version.

1. web

The web UI and basic functionality looks as follows:

  1. Landing

demo

  1. Login Page

demo

  1. Register Page

demo

  1. Home Page

This page is shown when you are authenticated.

demo

  1. Creating a New Pet

demodemo

  1. Opening a Pet

demodemo

  1. Edit Pet

demodemo

8. User Profile

demodemo

  1. Notifications

demo

  1. Messages

demodemo

  1. Request Reset Password Email Link

demo

  1. Changing Password

demo

2. mobile

The following are the basic screens of the mobile app of petmall.

  1. Landing

demo demo

  1. Auth Pages/Screens

demo demo demo demo demo

  1. App Home

demo

  1. Profile

This page is shown when you are authenticated.

demo demo

  1. Creating a New Pet

demo demo

  1. Opening a Pet

demo demo

  1. Notifications and Chats

demo demodemo

  1. Push Notifications

demo demo demo demo demo

Languages used

In this project I used the following languages:

- typescript

Tech Stack

In this project I used the following technologies.

  1. api
  • fastify server with mercurius graphql with type-graphql
  • jwt authentication
  • prisma
  • postgres database
  • redis cache
  1. web
  • react.js
  • semantic-ui for some components
  • react-icons for some icons
  • react-router-dom for pages and routing
  • urql graphql client
  • redux for state management
  • graphql-codegen in development for generating graphql-types from graphql documents
  • localStorage
  1. mobile
  • react-native
  • expo-font
  • react-native-navigation
  • urql graphql client
  • redux for state management
  • graphql-codegen in development for generating graphql-types from graphql documents
  • async-storage

License

In this project I'm using the MIT license which reads as follows:

MIT License

Copyright (c) 2023 crispengari

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.