Macfolio is my visionary project and I initiated this project as Personal Portfolio website. But it is much more than that. The Vision behind this project is to create a futuristic OS which will entirely work on/upon Cloud. Also, the use cases and outcome are endless, it'll be helpful to work using AR (Augmented Reality) and VR (Virtual Reality). Think it like - You can code or do whatever you do on laptop/PC by wearing glasses only (something like this: Instagram ). Sounds fascinating but improbable, right!
This project will also be helpful in getting rid of carrying bulky hardware devices and their unbearable costs. The used cases of this project are boundless.
- Install git (https://git-scm.com/download/win)
- Install Nodejs (https://nodejs.org/en/download/)
- Install MongoDB (https://docs.mongodb.com/manual/installation/)
- Alternative, Use MongoDB Atlas (MongoURI) for online database management (https://www.mongodb.com/cloud/atlas) or
- mLab (https://mlab.com/)
- ReactJS (https://reactjs.org/docs/getting-started.html) or (https://www.javatpoint.com/react-installation)
Clone the project Get to project directory Install dependencies:
npm install
cd client
npm install
- To start server:
npm start
Run app in dev mode:
npm run dev
Run Client:
cd client
npm start
- Add a file structure here with the basic details about files, below is current file structure.
└── Client
├── Public
├── src
└── package.json
├── Routes
│ ├── api
│ │ ├── visiapi.js
│ ├── explorer
│ │ ├── contact.js
│ │ └── explorer.js
│ │ └── feedback.js
└── Models
│ ├── feedback.js
│ ├── file.js
│ └── folder.js
│ └── visidata.js
├── LICENSE
├── CODE_OF_CONDUCT.md
├── README.md
├── package.json
├── server.js
- Backend: NodeJS (ExpressJs)
- Frontend: ReactJS, MaterialUI, JSX, CSS, JQuery
- Database: MongoDB using Mongoose
- Recommended Operating Systems
- Windows: 7 or newer
- MAC: OS X v10.7 or higher
- Linux: Ubuntu (Debian is Preferred)
- Supported Browsers
- Firefox 43+
- Chrome 51+
- Chromium
I have used Visual Studio Code for the entire development of this project and prefer the same for further development.
Your contributions are always welcome and appreciated. Following are the things you can do to contribute to this project.
-
Report a bug
If you think you have encountered a new issue, and I should know about it, feel free to report it here and I will take care of it. -
Create a pull request
It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues from here and make a pull request.
If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.
- No other permanent branches should be created in the main repository, you can create feature branches but they should get merged with the master.
MIT © 2020 Kartik Tyagi