| 
| 
| |
## Folder Structure
.
├── .github/ISSUE_TEMPLATE
├── doc # All Api doc and gif files
├── thisMyPCApp # Electron JS app folder
├── thisMyPCServer # Node JS MongoDB and Express JS server folder
├── thisMyPCWeb # Angular website folder
├── .gitignore
├── .gitlab-ci.yml
├── CODE_OF_CONDUCT.md
├── LICENSE
└── README.md
## What (This my pc) ?
The concept behind thismypc app was to transfer your computer folder and file information through a nodeJS server to the web end as JSON data.
## Why (This my pc) ?
- The app's responsive web interface helps you to browse file in any resolution device.
- You can use source code for your own projects.
- It works well in low bandwidth environments.
## How to (Wiki) ?
All usage instruction and information update on [Github Wiki](https://github.com/supunlakmal/thismypc/wiki).
## Developing
### Platforms
| Platform | Status |
| ----------------- | ---------- |
| Microsoft Windows | Developing |
| Linux | Pending |
| Mac os | Pending |
| Android | Developing |
#### Built With
- [Node JS](https://nodejs.org/en/)
- [GraphQL](http://graphql.org)
- [Express JS](https://expressjs.com/)
- [Socket IO](https://socket.io/)
- [Angular](https://angularjs.org/)
- [Electron JS](https://electronjs.org/)
- [Mongodb](https://www.mongodb.com/)
- [React Native](https://facebook.github.io/react-native/)
#### Clone Project
```shell
git clone https://github.com/supunlakmal/thismypc.git
```
This Command will copy a full project to your local environment
## Angular Project
### Setting up Angular Project
```shell
cd thisMyPCWeb
npm i
```
`cd thisMyPCWeb` Move into angular Project Folder
`npm i` install all dependency.
### Run Angular Project
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.
## Electron Project
### Setting up Electron Project
```shell
cd thisMyPCApp
npm i
```
`cd thisMyPCWeb` Move into Electron Project Folder
`npm i` install all dependency.
### Run Electron Project
Run `npm run start` start electron app in debug mode
## Node Server
### Setting up Node Server
```shell
cd thisMyPCServer
npm i
```
`cd thisMyPCServer` Move into Node Project Folder
`npm i` install all dependency.
### Run Node Project
Run `npm node index.js` to start node server
## Graphql
| URL |
| --------------- |
| /api/v1/graphql |
## REST API
### API Reference
- PC - Personal Computer
- thismypc.com:5000 - This is Thismypc web site API url. You can use your own localhost server link instead default Link.
- ":userID" - User ID
- ":computerKey" - Computer Key
### Web API
| Web API | URL | Description |
| ---------------------------- | ------------------------------------------ | ----------- |
| User Register | /api/v1/user/register | - |
| User Login | /api/v1/user/login | - |
| User Logout | /api/v1/user/:userID/logout | - |
| User Auth | /api/v1/user/authentication | - |
| User Info | /api/v1/user/:userID | - |
| User Online PC List | /api/v1/user/computer/online | - |
| Public PC Access | /api/v1/computer/public/access | - |
| User PC List | /api/v1/user/computer | - |
| Update User Account | /api/v1/user/update | - |
| Update User Password | /api/v1/user/password/edit | - |
| Update User PC Public status | /api/v1/user/computer/public/status/update | - |
| Update User PC Public Key | /api/v1/user/computer/public/key/update | - |
### Web socket IO
| Socket Name | Socket | Type | Description |
| ------------------------------ | ---------------------- | ---- | ----------- |
| Join Socket from Web | joinFromWeb | emit | - |
| Folder or Driver Open Request | openFolder | emit | - |
| PC access Requests | pcAccessRequest | emit | - |
| Get Hard Drive List | hDDList | on | - |
| Folder or hard drive open data | openFolderRequestToWeb | on | - |
### App API
| APP API | URL | Description |
| ------------------- | ------------------------------------------ | ----------- |
| User Login From App | /api/v1/user/computer/login | - |
| User Info | /api/v1/user/:userID/computer/:computerKey | - |
| User Logout | /api/v1/user/:userID/computer/logout | - |
### App socket IO
| Socket Name | Socket | Type | Description |
| --------------------------------------- | --------------------- | ---- | ----------- |
| Join Socket from APP | joinFromApp | emit | - |
| Send Hard Drive List | hDDList | emit | - |
| Send Data inside Folder or Hard Drive | sendOpenFolderRequest | emit | - |
| Send callback of Folder Create Function | folderCreateCallback | emit | - |
| PC access user and data | pcAccessRequest | on | - |
| Folder or Hard drive open request | openFolderRequest | on | - |
| Folder Validation | validateFolderName | on | - |
## Database
MongoDB use as Database.
## Licensing
The MIT License 2019 Supun Lakmal
================================================
FILE: thisMyPCApp/.eslintrc.js
================================================
module.exports = {
'env': {
'browser': true,
'commonjs': true,
'es6': true,
},
'extends': 'google',
'globals': {
'Atomics': 'readonly',
'SharedArrayBuffer': 'readonly',
},
'parserOptions': {
'ecmaVersion': 2018,
},
'rules': {
},
};
================================================
FILE: thisMyPCApp/README.md
================================================
# This My PC
| Status | Computer | Platform | Allow Public | Public access key |
|---|---|---|---|---|
| Online Offline | {{pc.pcName}} | {{pc.platform}} |
|
No Public Access Key
|
Welcome to the
Open Source Experimental Full Stack Project
ThisMyPC is a next-generation open source solution for remote pc. It's a full stack based project that starts as
an experiment.
You can get the source code from GitHub and use for your own purpose.
When we speak of free software, we are referring to freedom, not price.
Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine.
Angular is a TypeScript-based open-source full-stack web application framework led by the Angular Team at Google and by a community of individuals and corporations.
Electron is an open-source framework developed and maintained by GitHub. Electron allows for the development of desktop GUI applications using front and back end components originally developed for web applications
Express.js, or simply Express, is a web application framework for Node.js, released as free and open-source software under the MIT License. It is designed for building web applications and APIs.
React Native · A framework for building native apps using React
MongoDB is a cross-platform document-oriented database program. Classified as a NoSQL database program, MongoDB uses JSON-like documents with schemata.
Instructions
<head>
...
<link rel="stylesheet" type="text/css" href="your_website_domain/css_root/flaticon.css">
...
</head>
3Use the icon class on "display: inline" elements:
Use example: <i class="flaticon-airplane49"></i> or <span class="flaticon-airplane49"></span>
<i class="flaticon-guarantee"></i>
<i class="flaticon-shield"></i>
<i class="flaticon-support"></i>
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)
](http://godban.github.io/browsers-support-badges/)