Skip to content

A mimic website of Pinterest where one can share ideas , socialize and find inspirational ideas

License

Notifications You must be signed in to change notification settings

nadaabdelmaboud/Phantom

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Phantom Logo

Phantom

Table of Contents

  1. Description
  2. Screenshots
  3. Links
  4. Tools
  5. Getting Started
  6. Contributing
  7. Contributors
  8. License

Description

Phantom A mimic website of Pinterest where one can share ideas , socialize and find inspirational ideas .

Screenshots

  • Create New Phantom Account And Try It Yourself

    Sign Up

  • Tell Us What Interests You

    Interests

  • Explore Your Home Feed With Pins Recommended For You

    HomeFeed

  • Create Your Boards And Manage How They Look

    Profile Boards

  • Have More Control and Divide Your Board Into Sections

    Sections

  • Invite Collaborators Into Your Boards And Share Your Intersts

    Collaborators

  • Create Your Own Pins And Add Them To Your Boards

    Create Pin

  • Don't Miss A Thing And Keep Up With Your Notifications

    Notifications

  • Chat With Others And Make New Friends Who Share You Some Interests

    Chat

  • Follow People Recommended For You

    Follow

  • Tune Your Home Feed With What You Like

    Topics

  • Manage Your Profile Info And Account Settings

    Setting

  • Close Your Account Whenever You Want

    Close Account

  • Search By Filters About What You Want

    Search

  • Socialize More And Share Your Thoughts About Others' Pins

    Comments

    Reacts

  • Find More Ideas Related To A Pin You Opened

    More Pins

Links

Tools

  1. Frontend
    • Vue
    • Vue lazyload
    • Bootstrap
    • Firebase
    • Socket io
  2. Backend
    • Nestjs
    • Mongodb
    • Firebase
    • WebSockets
    • Google Api

Getting Started

  • Server

    • Run

         $ cd server/phantom
      
         # install
         $ npm install
      
         # development
         $ npm run start
      
         # watch mode
         $ npm run start:dev
      
         # production mode
         $ npm run start:prod
      
    • Env Variables

    • Database Seeds

         $ cd server/phantom
      
         $ npm install mongonaut
      
         #seeds will be added to a new mongo local db
         $ npm run seeds
    • Api Documentation

    • JsDoc

         $ cd server/phantom
      
         $ npm install -g "@compodoc/compodoc"
      
         $ npm run compodoc
         # then open documentation/index.html
  • Frontend

    • Frontend Run

          $ cd client
      
          # install
          $ npm install
      
          # development
          $ npm run serve
      
          # production mode
          $ npm run build
      
    • Frontend Env Variables

Contributing

1. Fork this repo
2. Create new branch
	$ git checkout -b <FeatureBranch>
3. Add your feature then
	$ git commit -m "add my feature"
	$ git push origin <FeatureBranch>
4. Create PR

Stay in touch

License

Phantom is MIT licensed.