tamascsaba / shareif

Secure data share app, guarded by Chuck Norris 🤠

🤠 Shareif

Secure data share app, guarded by Chuck Norris.

Demo: https://shareif.surge.sh/

📚 Architecture

------------------------------------------- Source Code ----------------------------------

              ┌─────────┐
              │  Source │
              └────┬────┘
                   │
                   ▼         
              ┌─────────┐ 
              │  Surge  │ 
              └────┬────┘
                   │                
-------------------│---------------------- Cloud (google and surge) -----------------------
                   ▼ 
              ┌───────────┐            ┌───────────┐ 
              │    CDN    │            │ Firestore │
              └───────────┘            └───────────┘  
-------------------│---------------------│-----▲---- Browser ------------------------------
                   │                     │     │ 
                   ▼                     ▼     │                         
              ┌───────────┐         ┌────────────────┐ 
              │    UI     ├──Data──►│ Encryt/Decrypt │
              └───────────┘         └────────────────┘                          

------

📗 Dream Architecture

------------------------------------------- Pipeline ---------------------------------------

          ┌   ┌─────────┐
          │   │ Source  │
          │   └────┬────┘
          │        ▼  
          │   ┌─────────┐
 Github   │   │  Tests  │
 Action   │   └────┬────┘
          │        ▼         
          │   ┌─────────┐ 
          │   │ Release │ 
          └   └────┬────┘
                   ▼
              ┌──────────┐
              │ Test env │
              └────┬─────┘               
-------------------│----------------------- Cloud -----------------------------------------
          ┌        ▼                                                         ┌ 
          │  ┌───────────┐          ┌───────────┐     ┌────────────┐         │  ┌───────────┐
 Google   │  │    CDN    │          │ Functions ├────►│  Firestore │  Senty  │  │  Sentry   │
 Cloud    │  └───────────┘          └───────────┘     └────────────┘  Cloud  │  └───────────┘
          └        │                   ▲     │                               └       ▲
-------------------│-------------------│-----│-- Browser ----------------------------│-----
                   │                   │     │                                       │
                   ▼                   │     ▼                                       │
              ┌───────────┐       ┌────────────────┐                                 │
              │    UI     ├─Data─►│ Encryt/Decrypt │                                 │
              └───────────┘       └────────────────┘                                 │
                   │                                                                 │
                   └──────────────────────── Log and errors──────────────────────────┘

-------------------------------------------------------------------------------------------

💾 Install

Run npm i or yarn

🎥 Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files.

📰 Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

📦 Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

💹 Running unit tests

Run ng test to execute the unit tests via Karma.

📊 Running end-to-end tests

Run ng e2e to execute the end-to-end tests via a platform of your choice. To use this command, you need to first add a package that implements end-to-end testing capabilities.