Phantom

Table of Contents

1. Description
2. Screenshots
3. Links
4. Tools
5. Getting Started
   • Server
     • Run
     • Env Variables
     • Database Seeds
     • Api Documentation
     • JsDoc
   • Frontend
     • Run
     • Env Variables
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

  

• Tell Us What Interests You

  

• Explore Your Home Feed With Pins Recommended For You

  

• Create Your Boards And Manage How They Look

  

• Have More Control and Divide Your Board Into Sections

  

• Invite Collaborators Into Your Boards And Share Your Intersts

  

• Create Your Own Pins And Add Them To Your Boards

  

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

  

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

  

• Follow People Recommended For You

  

• Tune Your Home Feed With What You Like

  

• Manage Your Profile Info And Account Settings

  

• Close Your Account Whenever You Want

  

• Search By Filters About What You Want

  

• Socialize More And Share Your Thoughts About Others' Pins

  

  

• Find More Ideas Related To A Pin You Opened

  

Links

• Website Url

• Api Base Url : https://daniphantomserver.herokuapp.com

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

    • refer to .env.example

  • Database Seeds

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

  • Api Documentation

    • refer to Api Doc

  • 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

    • refer to .env.example

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

• Frontend
  • Nihal Mansour - [email protected]
  • Eman Othman - [email protected]
  • Menna Mahmoud - [email protected]
• Backend
  • Dina Alaa - [email protected]
  • Aya Samir - [email protected]
  • Nada AbdElmaboud - [email protected]

License

Phantom is MIT licensed.